Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	provisional
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.Types

Contents

Authentication
- Credentials
- Environment
Logging
Signing
Service
Requests
Retries
Errors
Regions
Endpoints
HTTP
- Seconds

Description

Synopsis

newtype AccessKey = AccessKey ByteString
newtype SecretKey = SecretKey ByteString
newtype SessionToken = SessionToken ByteString
data Auth
- = Ref ThreadId (IORef AuthEnv)
- | Auth AuthEnv
withAuth :: MonadIO m => Auth -> (AuthEnv -> m a) -> m a
data AuthEnv = AuthEnv {
- _authAccessKeyId :: AccessKey
- _authSecretAccessKey :: Sensitive SecretKey
- _authSessionToken :: Maybe (Sensitive SessionToken)
- _authExpiration :: Maybe ISO8601
}
authAccessKeyId :: Lens' AuthEnv AccessKey
authSecretAccessKey :: Lens' AuthEnv SecretKey
authSessionToken :: Lens' AuthEnv (Maybe SessionToken)
authExpiration :: Lens' AuthEnv (Maybe UTCTime)
data LogLevel
- = Info
- | Error
- | Debug
- | Trace
type Logger = LogLevel -> ByteStringBuilder -> IO ()
type Algorithm a = Request a -> AuthEnv -> Region -> UTCTime -> Signed a
data Meta where
- Meta :: ToLog a => a -> Meta
data Signer = Signer {
- signerSign :: forall a. Algorithm a
- signerPresign :: forall a. Seconds -> Algorithm a
}
data Signed a = Signed {
- signedMeta :: Meta
- signedRequest :: ClientRequest
}
data Abbrev
data Service = Service {
- _serviceAbbrev :: Abbrev
- _serviceSigner :: Signer
- _serviceSigningName :: ByteString
- _serviceVersion :: ByteString
- _serviceEndpointPrefix :: ByteString
- _serviceEndpoint :: Region -> Endpoint
- _serviceTimeout :: Maybe Seconds
- _serviceCheck :: Status -> Bool
- _serviceError :: Status -> [Header] -> ByteStringLazy -> Error
- _serviceRetry :: Retry
}
serviceSigner :: Lens' Service Signer
serviceEndpoint :: Setter' Service Endpoint
serviceTimeout :: Lens' Service (Maybe Seconds)
serviceCheck :: Lens' Service (Status -> Bool)
serviceRetry :: Lens' Service Retry
class AWSRequest a where
- type AWSResponse a :: *
- request :: a -> Request a
- response :: MonadResource m => Logger -> Service -> Proxy a -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse a)))
data Request a = Request {
- _requestService :: Service
- _requestMethod :: StdMethod
- _requestPath :: RawPath
- _requestQuery :: QueryString
- _requestHeaders :: [Header]
- _requestBody :: RequestBody
}
requestService :: Lens' (Request a) Service
requestMethod :: Lens' (Request a) StdMethod
requestHeaders :: Lens' (Request a) [Header]
requestPath :: Lens' (Request a) RawPath
requestQuery :: Lens' (Request a) QueryString
requestBody :: Lens' (Request a) RequestBody
requestSign :: Algorithm a
requestPresign :: Seconds -> Algorithm a
requestUnsigned :: Request a -> Region -> ClientRequest
data Retry = Exponential {
- _retryBase :: Double
- _retryGrowth :: Int
- _retryAttempts :: Int
- _retryCheck :: ServiceError -> Maybe Text
}
exponentBase :: Lens' Retry Double
exponentGrowth :: Lens' Retry Int
retryAttempts :: Lens' Retry Int
retryCheck :: Lens' Retry (ServiceError -> Maybe Text)
class AsError a where
- _Error :: Prism' a Error
- _TransportError :: Prism' a HttpException
- _SerializeError :: Prism' a SerializeError
- _ServiceError :: Prism' a ServiceError
data Error
- = TransportError HttpException
- | SerializeError SerializeError
- | ServiceError ServiceError
data HttpException
data SerializeError = SerializeError' {
- _serializeErrorAbbrev :: Abbrev
- _serializeErrorStatus :: Status
- _serializeErrorBody :: Maybe ByteStringLazy
- _serializeErrorMessage :: String
}
serializeAbbrev :: Lens' SerializeError Abbrev
serializeStatus :: Lens' SerializeError Status
serializeMessage :: Lens' SerializeError String
data ServiceError = ServiceError' {
- _serviceErrorAbbrev :: Abbrev
- _serviceErrorStatus :: Status
- _serviceErrorHeaders :: [Header]
- _serviceErrorCode :: ErrorCode
- _serviceErrorMessage :: Maybe ErrorMessage
- _serviceErrorRequestId :: Maybe RequestId
}
serviceAbbrev :: Lens' ServiceError Abbrev
serviceStatus :: Lens' ServiceError Status
serviceHeaders :: Lens' ServiceError [Header]
serviceCode :: Lens' ServiceError ErrorCode
serviceMessage :: Lens' ServiceError (Maybe ErrorMessage)
serviceRequestId :: Lens' ServiceError (Maybe RequestId)
newtype ErrorCode = ErrorCode Text
newErrorCode :: Text -> ErrorCode
newtype ErrorMessage = ErrorMessage {
- fromErrorMessage :: Text
}
newtype RequestId = RequestId {
- fromRequestId :: Text
}
newtype Region where
- Region' {
  - fromRegion :: Text
  }
- pattern NorthVirginia :: Region
- pattern Ohio :: Region
- pattern NorthCalifornia :: Region
- pattern Oregon :: Region
- pattern GovCloudWest :: Region
- pattern GovCloudEast :: Region
- pattern Montreal :: Region
- pattern SaoPaulo :: Region
- pattern Frankfurt :: Region
- pattern Ireland :: Region
- pattern London :: Region
- pattern Milan :: Region
- pattern Paris :: Region
- pattern Stockholm :: Region
- pattern Bahrain :: Region
- pattern CapeTown :: Region
- pattern Beijing :: Region
- pattern Ningxia :: Region
- pattern HongKong :: Region
- pattern Tokyo :: Region
- pattern Seoul :: Region
- pattern Osaka :: Region
- pattern Singapore :: Region
- pattern Sydney :: Region
- pattern Mumbai :: Region
data Endpoint = Endpoint {
- _endpointHost :: ByteString
- _endpointSecure :: Bool
- _endpointPort :: Int
- _endpointScope :: ByteString
}
endpointHost :: Lens' Endpoint ByteString
endpointPort :: Lens' Endpoint Int
endpointSecure :: Lens' Endpoint Bool
endpointScope :: Lens' Endpoint ByteString
type ClientRequest = Request
type ClientResponse = Response
type ClientBody = ConduitM () ByteString (ResourceT IO) ()
newClientRequest :: Endpoint -> Maybe Seconds -> ClientRequest
newtype Seconds = Seconds Int
toSeconds :: Seconds -> Int
toMicroseconds :: Seconds -> Int

Authentication

Credentials

newtype AccessKey Source #

An access key ID.

For example: AKIAIOSFODNN7EXAMPLE

See: Understanding and Getting Your Security Credentials.

Constructors

AccessKey ByteString

Instances

Instances details

Eq AccessKey Source #
Instance details Defined in Amazonka.Types Methods (==) :: AccessKey -> AccessKey -> Bool # (/=) :: AccessKey -> AccessKey -> Bool #
Read AccessKey Source #
Instance details Defined in Amazonka.Types Methods readsPrec :: Int -> ReadS AccessKey # readList :: ReadS [AccessKey] # readPrec :: ReadPrec AccessKey # readListPrec :: ReadPrec [AccessKey] #
Show AccessKey Source #
Instance details Defined in Amazonka.Types Methods showsPrec :: Int -> AccessKey -> ShowS # show :: AccessKey -> String # showList :: [AccessKey] -> ShowS #
IsString AccessKey Source #
Instance details Defined in Amazonka.Types Methods fromString :: String -> AccessKey #
Generic AccessKey Source #
Instance details Defined in Amazonka.Types Associated Types type Rep AccessKey :: Type -> Type # Methods from :: AccessKey -> Rep AccessKey x # to :: Rep AccessKey x -> AccessKey #
NFData AccessKey Source #
Instance details Defined in Amazonka.Types Methods rnf :: AccessKey -> () #
Hashable AccessKey Source #
Instance details Defined in Amazonka.Types Methods hashWithSalt :: Int -> AccessKey -> Int # hash :: AccessKey -> Int #
ToJSON AccessKey Source #
Instance details Defined in Amazonka.Types Methods toJSON :: AccessKey -> Value # toEncoding :: AccessKey -> Encoding # toJSONList :: [AccessKey] -> Value # toEncodingList :: [AccessKey] -> Encoding #
FromJSON AccessKey Source #
Instance details Defined in Amazonka.Types Methods parseJSON :: Value -> Parser AccessKey # parseJSONList :: Value -> Parser [AccessKey] #
ToText AccessKey Source #
Instance details Defined in Amazonka.Types Methods toText :: AccessKey -> Text Source #
FromText AccessKey Source #
Instance details Defined in Amazonka.Types Methods fromText :: Text -> Either String AccessKey Source #
ToByteString AccessKey Source #
Instance details Defined in Amazonka.Types Methods toBS :: AccessKey -> ByteString Source #
ToXML AccessKey Source #
Instance details Defined in Amazonka.Types Methods toXML :: AccessKey -> XML Source #
FromXML AccessKey Source #
Instance details Defined in Amazonka.Types Methods parseXML :: [Node] -> Either String AccessKey Source #
ToQuery AccessKey Source #
Instance details Defined in Amazonka.Types Methods toQuery :: AccessKey -> QueryString Source #
ToLog AccessKey Source #
Instance details Defined in Amazonka.Types Methods build :: AccessKey -> ByteStringBuilder Source #
type Rep AccessKey Source #
Instance details Defined in Amazonka.Types type Rep AccessKey = D1 ('MetaData "AccessKey" "Amazonka.Types" "libZSamazonka-coreZSamazonka-core" 'True) (C1 ('MetaCons "AccessKey" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ByteString)))

newtype SecretKey Source #

Secret access key credential.

For example: wJalrXUtnFEMIK7MDENGbPxRfiCYEXAMPLEKE

See: Understanding and Getting Your Security Credentials.

Constructors

SecretKey ByteString

Instances

Instances details

Eq SecretKey Source #
Instance details Defined in Amazonka.Types Methods (==) :: SecretKey -> SecretKey -> Bool # (/=) :: SecretKey -> SecretKey -> Bool #
IsString SecretKey Source #
Instance details Defined in Amazonka.Types Methods fromString :: String -> SecretKey #
Generic SecretKey Source #
Instance details Defined in Amazonka.Types Associated Types type Rep SecretKey :: Type -> Type # Methods from :: SecretKey -> Rep SecretKey x # to :: Rep SecretKey x -> SecretKey #
NFData SecretKey Source #
Instance details Defined in Amazonka.Types Methods rnf :: SecretKey -> () #
Hashable SecretKey Source #
Instance details Defined in Amazonka.Types Methods hashWithSalt :: Int -> SecretKey -> Int # hash :: SecretKey -> Int #
ToJSON SecretKey Source #
Instance details Defined in Amazonka.Types Methods toJSON :: SecretKey -> Value # toEncoding :: SecretKey -> Encoding # toJSONList :: [SecretKey] -> Value # toEncodingList :: [SecretKey] -> Encoding #
FromJSON SecretKey Source #
Instance details Defined in Amazonka.Types Methods parseJSON :: Value -> Parser SecretKey # parseJSONList :: Value -> Parser [SecretKey] #
ToText SecretKey Source #
Instance details Defined in Amazonka.Types Methods toText :: SecretKey -> Text Source #
FromText SecretKey Source #
Instance details Defined in Amazonka.Types Methods fromText :: Text -> Either String SecretKey Source #
ToByteString SecretKey Source #
Instance details Defined in Amazonka.Types Methods toBS :: SecretKey -> ByteString Source #
ToXML SecretKey Source #
Instance details Defined in Amazonka.Types Methods toXML :: SecretKey -> XML Source #
FromXML SecretKey Source #
Instance details Defined in Amazonka.Types Methods parseXML :: [Node] -> Either String SecretKey Source #
type Rep SecretKey Source #
Instance details Defined in Amazonka.Types type Rep SecretKey = D1 ('MetaData "SecretKey" "Amazonka.Types" "libZSamazonka-coreZSamazonka-core" 'True) (C1 ('MetaCons "SecretKey" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ByteString)))

newtype SessionToken Source #

A session token used by STS to temporarily authorise access to an AWS resource.

See: Temporary Security Credentials.

Constructors

SessionToken ByteString

Instances

Instances details

Eq SessionToken Source #
Instance details Defined in Amazonka.Types Methods (==) :: SessionToken -> SessionToken -> Bool # (/=) :: SessionToken -> SessionToken -> Bool #
IsString SessionToken Source #
Instance details Defined in Amazonka.Types Methods fromString :: String -> SessionToken #
Generic SessionToken Source #
Instance details Defined in Amazonka.Types Associated Types type Rep SessionToken :: Type -> Type # Methods from :: SessionToken -> Rep SessionToken x # to :: Rep SessionToken x -> SessionToken #
NFData SessionToken Source #
Instance details Defined in Amazonka.Types Methods rnf :: SessionToken -> () #
Hashable SessionToken Source #
Instance details Defined in Amazonka.Types Methods hashWithSalt :: Int -> SessionToken -> Int # hash :: SessionToken -> Int #
ToJSON SessionToken Source #
Instance details Defined in Amazonka.Types Methods toJSON :: SessionToken -> Value # toEncoding :: SessionToken -> Encoding # toJSONList :: [SessionToken] -> Value # toEncodingList :: [SessionToken] -> Encoding #
FromJSON SessionToken Source #
Instance details Defined in Amazonka.Types Methods parseJSON :: Value -> Parser SessionToken # parseJSONList :: Value -> Parser [SessionToken] #
ToText SessionToken Source #
Instance details Defined in Amazonka.Types Methods toText :: SessionToken -> Text Source #
FromText SessionToken Source #
Instance details Defined in Amazonka.Types Methods fromText :: Text -> Either String SessionToken Source #
ToByteString SessionToken Source #
Instance details Defined in Amazonka.Types Methods toBS :: SessionToken -> ByteString Source #
ToXML SessionToken Source #
Instance details Defined in Amazonka.Types Methods toXML :: SessionToken -> XML Source #
FromXML SessionToken Source #
Instance details Defined in Amazonka.Types Methods parseXML :: [Node] -> Either String SessionToken Source #
type Rep SessionToken Source #
Instance details Defined in Amazonka.Types type Rep SessionToken = D1 ('MetaData "SessionToken" "Amazonka.Types" "libZSamazonka-coreZSamazonka-core" 'True) (C1 ('MetaCons "SessionToken" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ByteString)))

Environment

data Auth Source #

An authorisation environment containing AWS credentials, and potentially a reference which can be refreshed out-of-band as temporary credentials expire.

Constructors

Ref ThreadId (IORef AuthEnv)
Auth AuthEnv

Instances

Instances details

ToLog Auth Source #
Instance details Defined in Amazonka.Types Methods build :: Auth -> ByteStringBuilder Source #

withAuth :: MonadIO m => Auth -> (AuthEnv -> m a) -> m a Source #

data AuthEnv Source #

The AuthN/AuthZ credential environment.

Constructors

AuthEnv
Fields _authAccessKeyId :: AccessKey _authSecretAccessKey :: Sensitive SecretKey _authSessionToken :: Maybe (Sensitive SessionToken) _authExpiration :: Maybe ISO8601

Instances

Instances details

Eq AuthEnv Source #
Instance details Defined in Amazonka.Types Methods (==) :: AuthEnv -> AuthEnv -> Bool # (/=) :: AuthEnv -> AuthEnv -> Bool #
Show AuthEnv Source #
Instance details Defined in Amazonka.Types Methods showsPrec :: Int -> AuthEnv -> ShowS # show :: AuthEnv -> String # showList :: [AuthEnv] -> ShowS #
Generic AuthEnv Source #
Instance details Defined in Amazonka.Types Associated Types type Rep AuthEnv :: Type -> Type # Methods from :: AuthEnv -> Rep AuthEnv x # to :: Rep AuthEnv x -> AuthEnv #
NFData AuthEnv Source #
Instance details Defined in Amazonka.Types Methods rnf :: AuthEnv -> () #
FromJSON AuthEnv Source #
Instance details Defined in Amazonka.Types Methods parseJSON :: Value -> Parser AuthEnv # parseJSONList :: Value -> Parser [AuthEnv] #
FromXML AuthEnv Source #
Instance details Defined in Amazonka.Types Methods parseXML :: [Node] -> Either String AuthEnv Source #
ToLog AuthEnv Source #
Instance details Defined in Amazonka.Types Methods build :: AuthEnv -> ByteStringBuilder Source #
type Rep AuthEnv Source #
Instance details Defined in Amazonka.Types type Rep AuthEnv = D1 ('MetaData "AuthEnv" "Amazonka.Types" "libZSamazonka-coreZSamazonka-core" 'False) (C1 ('MetaCons "AuthEnv" 'PrefixI 'True) ((S1 ('MetaSel ('Just "_authAccessKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 AccessKey) :: S1 ('MetaSel ('Just "_authSecretAccessKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive SecretKey))) :: (S1 ('MetaSel ('Just "_authSessionToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive SessionToken))) :*: S1 ('MetaSel ('Just "_authExpiration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)))))

authAccessKeyId :: Lens' AuthEnv AccessKey Source #

The access key ID that identifies the temporary security credentials.

authSecretAccessKey :: Lens' AuthEnv SecretKey Source #

The secret access key that can be used to sign requests.

authSessionToken :: Lens' AuthEnv (Maybe SessionToken) Source #

The token that users must pass to the service API to use the temporary credentials.

authExpiration :: Lens' AuthEnv (Maybe UTCTime) Source #

The date on which the current credentials expire.

Logging

data LogLevel Source #

Constructors

Info	Info messages supplied by the user - this level is not emitted by the library.
Error	Error messages only.
Debug	Useful debug information + info + error levels.
Trace	Includes potentially sensitive signing metadata, and non-streaming response bodies.

Instances

Instances details

Enum LogLevel Source #
Instance details Defined in Amazonka.Types Methods succ :: LogLevel -> LogLevel # pred :: LogLevel -> LogLevel # toEnum :: Int -> LogLevel # fromEnum :: LogLevel -> Int # enumFrom :: LogLevel -> [LogLevel] # enumFromThen :: LogLevel -> LogLevel -> [LogLevel] # enumFromTo :: LogLevel -> LogLevel -> [LogLevel] # enumFromThenTo :: LogLevel -> LogLevel -> LogLevel -> [LogLevel] #
Eq LogLevel Source #
Instance details Defined in Amazonka.Types Methods (==) :: LogLevel -> LogLevel -> Bool # (/=) :: LogLevel -> LogLevel -> Bool #
Ord LogLevel Source #
Instance details Defined in Amazonka.Types Methods compare :: LogLevel -> LogLevel -> Ordering # (<) :: LogLevel -> LogLevel -> Bool # (<=) :: LogLevel -> LogLevel -> Bool # (>) :: LogLevel -> LogLevel -> Bool # (>=) :: LogLevel -> LogLevel -> Bool # max :: LogLevel -> LogLevel -> LogLevel # min :: LogLevel -> LogLevel -> LogLevel #
Show LogLevel Source #
Instance details Defined in Amazonka.Types Methods showsPrec :: Int -> LogLevel -> ShowS # show :: LogLevel -> String # showList :: [LogLevel] -> ShowS #
Generic LogLevel Source #
Instance details Defined in Amazonka.Types Associated Types type Rep LogLevel :: Type -> Type # Methods from :: LogLevel -> Rep LogLevel x # to :: Rep LogLevel x -> LogLevel #
ToText LogLevel Source #
Instance details Defined in Amazonka.Types Methods toText :: LogLevel -> Text Source #
FromText LogLevel Source #
Instance details Defined in Amazonka.Types Methods fromText :: Text -> Either String LogLevel Source #
ToByteString LogLevel Source #
Instance details Defined in Amazonka.Types Methods toBS :: LogLevel -> ByteString Source #
type Rep LogLevel Source #
Instance details Defined in Amazonka.Types type Rep LogLevel = D1 ('MetaData "LogLevel" "Amazonka.Types" "libZSamazonka-coreZSamazonka-core" 'False) ((C1 ('MetaCons "Info" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Error" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "Debug" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Trace" 'PrefixI 'False) (U1 :: Type -> Type)))

type Logger = LogLevel -> ByteStringBuilder -> IO () Source #

A function threaded through various request and serialisation routines to log informational and debug messages.

Signing

type Algorithm a = Request a -> AuthEnv -> Region -> UTCTime -> Signed a Source #

data Meta where Source #

Signing algorithm specific metadata.

Constructors

Meta :: ToLog a => a -> Meta

Instances

Instances details

ToLog Meta Source #
Instance details Defined in Amazonka.Types Methods build :: Meta -> ByteStringBuilder Source #

data Signer Source #

Constructors

Signer
Fields signerSign :: forall a. Algorithm a signerPresign :: forall a. Seconds -> Algorithm a

data Signed a Source #

A signed ClientRequest and associated metadata specific to the signing algorithm, tagged with the initial request type to be able to obtain the associated response, AWSResponse a.

Constructors

Signed
Fields signedMeta :: Meta signedRequest :: ClientRequest

Service

data Abbrev Source #

Abbreviated service name.

Instances

Instances details

Eq Abbrev Source #
Instance details Defined in Amazonka.Types Methods (==) :: Abbrev -> Abbrev -> Bool # (/=) :: Abbrev -> Abbrev -> Bool #
Ord Abbrev Source #
Instance details Defined in Amazonka.Types Methods compare :: Abbrev -> Abbrev -> Ordering # (<) :: Abbrev -> Abbrev -> Bool # (<=) :: Abbrev -> Abbrev -> Bool # (>) :: Abbrev -> Abbrev -> Bool # (>=) :: Abbrev -> Abbrev -> Bool # max :: Abbrev -> Abbrev -> Abbrev # min :: Abbrev -> Abbrev -> Abbrev #
Show Abbrev Source #
Instance details Defined in Amazonka.Types Methods showsPrec :: Int -> Abbrev -> ShowS # show :: Abbrev -> String # showList :: [Abbrev] -> ShowS #
IsString Abbrev Source #
Instance details Defined in Amazonka.Types Methods fromString :: String -> Abbrev #
Generic Abbrev Source #
Instance details Defined in Amazonka.Types Associated Types type Rep Abbrev :: Type -> Type # Methods from :: Abbrev -> Rep Abbrev x # to :: Rep Abbrev x -> Abbrev #
FromJSON Abbrev Source #
Instance details Defined in Amazonka.Types Methods parseJSON :: Value -> Parser Abbrev # parseJSONList :: Value -> Parser [Abbrev] #
ToText Abbrev Source #
Instance details Defined in Amazonka.Types Methods toText :: Abbrev -> Text Source #
FromText Abbrev Source #
Instance details Defined in Amazonka.Types Methods fromText :: Text -> Either String Abbrev Source #
FromXML Abbrev Source #
Instance details Defined in Amazonka.Types Methods parseXML :: [Node] -> Either String Abbrev Source #
ToLog Abbrev Source #
Instance details Defined in Amazonka.Types Methods build :: Abbrev -> ByteStringBuilder Source #
type Rep Abbrev Source #
Instance details Defined in Amazonka.Types type Rep Abbrev = D1 ('MetaData "Abbrev" "Amazonka.Types" "libZSamazonka-coreZSamazonka-core" 'True) (C1 ('MetaCons "Abbrev" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromAbbrev") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

data Service Source #

Attributes and functions specific to an AWS service.

Constructors

Service
Fields _serviceAbbrev :: Abbrev _serviceSigner :: Signer _serviceSigningName :: ByteString _serviceVersion :: ByteString _serviceEndpointPrefix :: ByteString _serviceEndpoint :: Region -> Endpoint _serviceTimeout :: Maybe Seconds _serviceCheck :: Status -> Bool _serviceError :: Status -> [Header] -> ByteStringLazy -> Error _serviceRetry :: Retry

Instances

Instances details

Generic Service Source #
Instance details Defined in Amazonka.Types Associated Types type Rep Service :: Type -> Type # Methods from :: Service -> Rep Service x # to :: Rep Service x -> Service #
type Rep Service Source #
Instance details Defined in Amazonka.Types type Rep Service = D1 ('MetaData "Service" "Amazonka.Types" "libZSamazonka-coreZSamazonka-core" 'False) (C1 ('MetaCons "Service" 'PrefixI 'True) (((S1 ('MetaSel ('Just "_serviceAbbrev") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Abbrev) :: S1 ('MetaSel ('Just "_serviceSigner") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Signer)) :: (S1 ('MetaSel ('Just "_serviceSigningName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ByteString) :: (S1 ('MetaSel ('Just "_serviceVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ByteString) :: S1 ('MetaSel ('Just "_serviceEndpointPrefix") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ByteString)))) :: ((S1 ('MetaSel ('Just "_serviceEndpoint") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Region -> Endpoint)) :: S1 ('MetaSel ('Just "_serviceTimeout") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Seconds))) :: (S1 ('MetaSel ('Just "_serviceCheck") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Status -> Bool)) :: (S1 ('MetaSel ('Just "_serviceError") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Status -> [Header] -> ByteStringLazy -> Error)) :*: S1 ('MetaSel ('Just "_serviceRetry") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Retry))))))

serviceSigner :: Lens' Service Signer Source #

serviceEndpoint :: Setter' Service Endpoint Source #

serviceTimeout :: Lens' Service (Maybe Seconds) Source #

serviceCheck :: Lens' Service (Status -> Bool) Source #

serviceRetry :: Lens' Service Retry Source #

Requests

class AWSRequest a where Source #

Specify how a request can be de/serialised.

Associated Types

type AWSResponse a :: * Source #

The successful, expected response associated with a request.

Methods

request :: a -> Request a Source #

response :: MonadResource m => Logger -> Service -> Proxy a -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse a))) Source #

data Request a Source #

An unsigned request.

Constructors

Request
Fields _requestService :: Service _requestMethod :: StdMethod _requestPath :: RawPath _requestQuery :: QueryString _requestHeaders :: [Header] _requestBody :: RequestBody

Instances

Instances details

Generic (Request a) Source #
Instance details Defined in Amazonka.Types Associated Types type Rep (Request a) :: Type -> Type # Methods from :: Request a -> Rep (Request a) x # to :: Rep (Request a) x -> Request a #
type Rep (Request a) Source #
Instance details Defined in Amazonka.Types type Rep (Request a) = D1 ('MetaData "Request" "Amazonka.Types" "libZSamazonka-coreZSamazonka-core" 'False) (C1 ('MetaCons "Request" 'PrefixI 'True) ((S1 ('MetaSel ('Just "_requestService") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Service) :: (S1 ('MetaSel ('Just "_requestMethod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 StdMethod) :: S1 ('MetaSel ('Just "_requestPath") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 RawPath))) :: (S1 ('MetaSel ('Just "_requestQuery") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 QueryString) :: (S1 ('MetaSel ('Just "_requestHeaders") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Header]) :*: S1 ('MetaSel ('Just "_requestBody") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 RequestBody)))))

requestService :: Lens' (Request a) Service Source #

requestMethod :: Lens' (Request a) StdMethod Source #

requestHeaders :: Lens' (Request a) [Header] Source #

requestPath :: Lens' (Request a) RawPath Source #

requestQuery :: Lens' (Request a) QueryString Source #

requestBody :: Lens' (Request a) RequestBody Source #

requestSign :: Algorithm a Source #

requestPresign :: Seconds -> Algorithm a Source #

requestUnsigned :: Request a -> Region -> ClientRequest Source #

Create an unsigned ClientRequest. You will almost never need to do this.

Retries

data Retry Source #

Constants and predicates used to create a RetryPolicy.

Constructors

Exponential
Fields _retryBase :: Double _retryGrowth :: Int _retryAttempts :: Int _retryCheck :: ServiceError -> Maybe Text Returns a descriptive name for logging if the request should be retried.

Instances

Instances details

Generic Retry Source #
Instance details Defined in Amazonka.Types Associated Types type Rep Retry :: Type -> Type # Methods from :: Retry -> Rep Retry x # to :: Rep Retry x -> Retry #
type Rep Retry Source #
Instance details Defined in Amazonka.Types type Rep Retry = D1 ('MetaData "Retry" "Amazonka.Types" "libZSamazonka-coreZSamazonka-core" 'False) (C1 ('MetaCons "Exponential" 'PrefixI 'True) ((S1 ('MetaSel ('Just "_retryBase") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Double) :: S1 ('MetaSel ('Just "_retryGrowth") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)) :: (S1 ('MetaSel ('Just "_retryAttempts") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "_retryCheck") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (ServiceError -> Maybe Text)))))

exponentBase :: Lens' Retry Double Source #

exponentGrowth :: Lens' Retry Int Source #

retryAttempts :: Lens' Retry Int Source #

retryCheck :: Lens' Retry (ServiceError -> Maybe Text) Source #

Errors

class AsError a where Source #

Minimal complete definition

_Error

Methods

_Error :: Prism' a Error Source #

A general Amazonka error.

_TransportError :: Prism' a HttpException Source #

An error occured while communicating over HTTP with a remote service.

_SerializeError :: Prism' a SerializeError Source #

A serialisation error occured when attempting to deserialise a response.

_ServiceError :: Prism' a ServiceError Source #

A service specific error returned by the remote service.

Instances

Instances details

AsError SomeException Source #
Instance details Defined in Amazonka.Types Methods _Error :: Prism' SomeException Error Source # _TransportError :: Prism' SomeException HttpException Source # _SerializeError :: Prism' SomeException SerializeError Source # _ServiceError :: Prism' SomeException ServiceError Source #
AsError Error Source #
Instance details Defined in Amazonka.Types Methods _Error :: Prism' Error Error Source # _TransportError :: Prism' Error HttpException Source # _SerializeError :: Prism' Error SerializeError Source # _ServiceError :: Prism' Error ServiceError Source #

data Error Source #

An error type representing errors that can be attributed to this library.

Constructors

TransportError HttpException
SerializeError SerializeError
ServiceError ServiceError

Instances

Instances details

Show Error Source #
Instance details Defined in Amazonka.Types Methods showsPrec :: Int -> Error -> ShowS # show :: Error -> String # showList :: [Error] -> ShowS #
Generic Error Source #
Instance details Defined in Amazonka.Types Associated Types type Rep Error :: Type -> Type # Methods from :: Error -> Rep Error x # to :: Rep Error x -> Error #
Exception Error Source #
Instance details Defined in Amazonka.Types Methods toException :: Error -> SomeException # fromException :: SomeException -> Maybe Error # displayException :: Error -> String #
ToLog Error Source #
Instance details Defined in Amazonka.Types Methods build :: Error -> ByteStringBuilder Source #
AsError Error Source #
Instance details Defined in Amazonka.Types Methods _Error :: Prism' Error Error Source # _TransportError :: Prism' Error HttpException Source # _SerializeError :: Prism' Error SerializeError Source # _ServiceError :: Prism' Error ServiceError Source #
type Rep Error Source #
Instance details Defined in Amazonka.Types type Rep Error = D1 ('MetaData "Error" "Amazonka.Types" "libZSamazonka-coreZSamazonka-core" 'False) (C1 ('MetaCons "TransportError" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 HttpException)) :+: (C1 ('MetaCons "SerializeError" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 SerializeError)) :+: C1 ('MetaCons "ServiceError" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ServiceError))))

HTTP Errors

data HttpException #

An exception which may be generated by this library

Since: http-client-0.5.0

Instances

Instances details

Show HttpException
Instance details Defined in Network.HTTP.Client.Types Methods showsPrec :: Int -> HttpException -> ShowS # show :: HttpException -> String # showList :: [HttpException] -> ShowS #
Exception HttpException
Instance details Defined in Network.HTTP.Client.Types Methods toException :: HttpException -> SomeException # fromException :: SomeException -> Maybe HttpException # displayException :: HttpException -> String #
ToLog HttpException Source #
Instance details Defined in Amazonka.Data.Log Methods build :: HttpException -> ByteStringBuilder Source #

Serialize Errors

data SerializeError Source #

Constructors

SerializeError'
Fields _serializeErrorAbbrev :: Abbrev _serializeErrorStatus :: Status _serializeErrorBody :: Maybe ByteStringLazy The response body, if the response was not streaming. _serializeErrorMessage :: String

Instances

Instances details

Eq SerializeError Source #
Instance details Defined in Amazonka.Types Methods (==) :: SerializeError -> SerializeError -> Bool # (/=) :: SerializeError -> SerializeError -> Bool #
Show SerializeError Source #
Instance details Defined in Amazonka.Types Methods showsPrec :: Int -> SerializeError -> ShowS # show :: SerializeError -> String # showList :: [SerializeError] -> ShowS #
Generic SerializeError Source #
Instance details Defined in Amazonka.Types Associated Types type Rep SerializeError :: Type -> Type # Methods from :: SerializeError -> Rep SerializeError x # to :: Rep SerializeError x -> SerializeError #
ToLog SerializeError Source #
Instance details Defined in Amazonka.Types Methods build :: SerializeError -> ByteStringBuilder Source #
type Rep SerializeError Source #
Instance details Defined in Amazonka.Types type Rep SerializeError = D1 ('MetaData "SerializeError" "Amazonka.Types" "libZSamazonka-coreZSamazonka-core" 'False) (C1 ('MetaCons "SerializeError'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "_serializeErrorAbbrev") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Abbrev) :: S1 ('MetaSel ('Just "_serializeErrorStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Status)) :: (S1 ('MetaSel ('Just "_serializeErrorBody") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ByteStringLazy)) :*: S1 ('MetaSel ('Just "_serializeErrorMessage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 String))))

serializeAbbrev :: Lens' SerializeError Abbrev Source #

serializeStatus :: Lens' SerializeError Status Source #

serializeMessage :: Lens' SerializeError String Source #

Service Errors

data ServiceError Source #

Constructors

ServiceError'
Fields _serviceErrorAbbrev :: Abbrev _serviceErrorStatus :: Status _serviceErrorHeaders :: [Header] _serviceErrorCode :: ErrorCode _serviceErrorMessage :: Maybe ErrorMessage _serviceErrorRequestId :: Maybe RequestId

Instances

Instances details

Eq ServiceError Source #
Instance details Defined in Amazonka.Types Methods (==) :: ServiceError -> ServiceError -> Bool # (/=) :: ServiceError -> ServiceError -> Bool #
Show ServiceError Source #
Instance details Defined in Amazonka.Types Methods showsPrec :: Int -> ServiceError -> ShowS # show :: ServiceError -> String # showList :: [ServiceError] -> ShowS #
Generic ServiceError Source #
Instance details Defined in Amazonka.Types Associated Types type Rep ServiceError :: Type -> Type # Methods from :: ServiceError -> Rep ServiceError x # to :: Rep ServiceError x -> ServiceError #
ToLog ServiceError Source #
Instance details Defined in Amazonka.Types Methods build :: ServiceError -> ByteStringBuilder Source #
type Rep ServiceError Source #
Instance details Defined in Amazonka.Types type Rep ServiceError = D1 ('MetaData "ServiceError" "Amazonka.Types" "libZSamazonka-coreZSamazonka-core" 'False) (C1 ('MetaCons "ServiceError'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "_serviceErrorAbbrev") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Abbrev) :: (S1 ('MetaSel ('Just "_serviceErrorStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Status) :: S1 ('MetaSel ('Just "_serviceErrorHeaders") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Header]))) :: (S1 ('MetaSel ('Just "_serviceErrorCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ErrorCode) :: (S1 ('MetaSel ('Just "_serviceErrorMessage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ErrorMessage)) :*: S1 ('MetaSel ('Just "_serviceErrorRequestId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RequestId))))))

serviceAbbrev :: Lens' ServiceError Abbrev Source #

serviceStatus :: Lens' ServiceError Status Source #

serviceHeaders :: Lens' ServiceError [Header] Source #

serviceCode :: Lens' ServiceError ErrorCode Source #

serviceMessage :: Lens' ServiceError (Maybe ErrorMessage) Source #

serviceRequestId :: Lens' ServiceError (Maybe RequestId) Source #

Error Types

newtype ErrorCode Source #

Constructors

ErrorCode Text

Instances

Instances details

Eq ErrorCode Source #
Instance details Defined in Amazonka.Types Methods (==) :: ErrorCode -> ErrorCode -> Bool # (/=) :: ErrorCode -> ErrorCode -> Bool #
Ord ErrorCode Source #
Instance details Defined in Amazonka.Types Methods compare :: ErrorCode -> ErrorCode -> Ordering # (<) :: ErrorCode -> ErrorCode -> Bool # (<=) :: ErrorCode -> ErrorCode -> Bool # (>) :: ErrorCode -> ErrorCode -> Bool # (>=) :: ErrorCode -> ErrorCode -> Bool # max :: ErrorCode -> ErrorCode -> ErrorCode # min :: ErrorCode -> ErrorCode -> ErrorCode #
Show ErrorCode Source #
Instance details Defined in Amazonka.Types Methods showsPrec :: Int -> ErrorCode -> ShowS # show :: ErrorCode -> String # showList :: [ErrorCode] -> ShowS #
IsString ErrorCode Source #
Instance details Defined in Amazonka.Types Methods fromString :: String -> ErrorCode #
FromJSON ErrorCode Source #
Instance details Defined in Amazonka.Types Methods parseJSON :: Value -> Parser ErrorCode # parseJSONList :: Value -> Parser [ErrorCode] #
ToText ErrorCode Source #
Instance details Defined in Amazonka.Types Methods toText :: ErrorCode -> Text Source #
FromText ErrorCode Source #
Instance details Defined in Amazonka.Types Methods fromText :: Text -> Either String ErrorCode Source #
FromXML ErrorCode Source #
Instance details Defined in Amazonka.Types Methods parseXML :: [Node] -> Either String ErrorCode Source #
ToLog ErrorCode Source #
Instance details Defined in Amazonka.Types Methods build :: ErrorCode -> ByteStringBuilder Source #

newErrorCode :: Text -> ErrorCode Source #

Construct an ErrorCode.

newtype ErrorMessage Source #

Constructors

ErrorMessage
Fields fromErrorMessage :: Text

Instances

Instances details

Eq ErrorMessage Source #
Instance details Defined in Amazonka.Types Methods (==) :: ErrorMessage -> ErrorMessage -> Bool # (/=) :: ErrorMessage -> ErrorMessage -> Bool #
Ord ErrorMessage Source #
Instance details Defined in Amazonka.Types Methods compare :: ErrorMessage -> ErrorMessage -> Ordering # (<) :: ErrorMessage -> ErrorMessage -> Bool # (<=) :: ErrorMessage -> ErrorMessage -> Bool # (>) :: ErrorMessage -> ErrorMessage -> Bool # (>=) :: ErrorMessage -> ErrorMessage -> Bool # max :: ErrorMessage -> ErrorMessage -> ErrorMessage # min :: ErrorMessage -> ErrorMessage -> ErrorMessage #
Show ErrorMessage Source #
Instance details Defined in Amazonka.Types Methods showsPrec :: Int -> ErrorMessage -> ShowS # show :: ErrorMessage -> String # showList :: [ErrorMessage] -> ShowS #
IsString ErrorMessage Source #
Instance details Defined in Amazonka.Types Methods fromString :: String -> ErrorMessage #
Generic ErrorMessage Source #
Instance details Defined in Amazonka.Types Associated Types type Rep ErrorMessage :: Type -> Type # Methods from :: ErrorMessage -> Rep ErrorMessage x # to :: Rep ErrorMessage x -> ErrorMessage #
FromJSON ErrorMessage Source #
Instance details Defined in Amazonka.Types Methods parseJSON :: Value -> Parser ErrorMessage # parseJSONList :: Value -> Parser [ErrorMessage] #
ToText ErrorMessage Source #
Instance details Defined in Amazonka.Types Methods toText :: ErrorMessage -> Text Source #
FromText ErrorMessage Source #
Instance details Defined in Amazonka.Types Methods fromText :: Text -> Either String ErrorMessage Source #
FromXML ErrorMessage Source #
Instance details Defined in Amazonka.Types Methods parseXML :: [Node] -> Either String ErrorMessage Source #
ToLog ErrorMessage Source #
Instance details Defined in Amazonka.Types Methods build :: ErrorMessage -> ByteStringBuilder Source #
type Rep ErrorMessage Source #
Instance details Defined in Amazonka.Types type Rep ErrorMessage = D1 ('MetaData "ErrorMessage" "Amazonka.Types" "libZSamazonka-coreZSamazonka-core" 'True) (C1 ('MetaCons "ErrorMessage" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromErrorMessage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

newtype RequestId Source #

Constructors

RequestId
Fields fromRequestId :: Text

Instances

Instances details

Eq RequestId Source #
Instance details Defined in Amazonka.Types Methods (==) :: RequestId -> RequestId -> Bool # (/=) :: RequestId -> RequestId -> Bool #
Ord RequestId Source #
Instance details Defined in Amazonka.Types Methods compare :: RequestId -> RequestId -> Ordering # (<) :: RequestId -> RequestId -> Bool # (<=) :: RequestId -> RequestId -> Bool # (>) :: RequestId -> RequestId -> Bool # (>=) :: RequestId -> RequestId -> Bool # max :: RequestId -> RequestId -> RequestId # min :: RequestId -> RequestId -> RequestId #
Show RequestId Source #
Instance details Defined in Amazonka.Types Methods showsPrec :: Int -> RequestId -> ShowS # show :: RequestId -> String # showList :: [RequestId] -> ShowS #
IsString RequestId Source #
Instance details Defined in Amazonka.Types Methods fromString :: String -> RequestId #
Generic RequestId Source #
Instance details Defined in Amazonka.Types Associated Types type Rep RequestId :: Type -> Type # Methods from :: RequestId -> Rep RequestId x # to :: Rep RequestId x -> RequestId #
FromJSON RequestId Source #
Instance details Defined in Amazonka.Types Methods parseJSON :: Value -> Parser RequestId # parseJSONList :: Value -> Parser [RequestId] #
ToText RequestId Source #
Instance details Defined in Amazonka.Types Methods toText :: RequestId -> Text Source #
FromText RequestId Source #
Instance details Defined in Amazonka.Types Methods fromText :: Text -> Either String RequestId Source #
FromXML RequestId Source #
Instance details Defined in Amazonka.Types Methods parseXML :: [Node] -> Either String RequestId Source #
ToLog RequestId Source #
Instance details Defined in Amazonka.Types Methods build :: RequestId -> ByteStringBuilder Source #
type Rep RequestId Source #
Instance details Defined in Amazonka.Types type Rep RequestId = D1 ('MetaData "RequestId" "Amazonka.Types" "libZSamazonka-coreZSamazonka-core" 'True) (C1 ('MetaCons "RequestId" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromRequestId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

Regions

newtype Region Source #

The available AWS regions.

Constructors

Region'
Fields fromRegion :: Text

Bundled Patterns

pattern NorthVirginia :: Region
pattern Ohio :: Region
pattern NorthCalifornia :: Region
pattern Oregon :: Region
pattern GovCloudWest :: Region
pattern GovCloudEast :: Region
pattern Montreal :: Region
pattern SaoPaulo :: Region
pattern Frankfurt :: Region
pattern Ireland :: Region
pattern London :: Region
pattern Milan :: Region
pattern Paris :: Region
pattern Stockholm :: Region
pattern Bahrain :: Region
pattern CapeTown :: Region
pattern Beijing :: Region
pattern Ningxia :: Region
pattern HongKong :: Region
pattern Tokyo :: Region
pattern Seoul :: Region
pattern Osaka :: Region
pattern Singapore :: Region
pattern Sydney :: Region
pattern Mumbai :: Region

Instances

Instances details

Eq Region Source #
Instance details Defined in Amazonka.Types Methods (==) :: Region -> Region -> Bool # (/=) :: Region -> Region -> Bool #
Ord Region Source #
Instance details Defined in Amazonka.Types Methods compare :: Region -> Region -> Ordering # (<) :: Region -> Region -> Bool # (<=) :: Region -> Region -> Bool # (>) :: Region -> Region -> Bool # (>=) :: Region -> Region -> Bool # max :: Region -> Region -> Region # min :: Region -> Region -> Region #
Read Region Source #
Instance details Defined in Amazonka.Types Methods readsPrec :: Int -> ReadS Region # readList :: ReadS [Region] # readPrec :: ReadPrec Region # readListPrec :: ReadPrec [Region] #
Show Region Source #
Instance details Defined in Amazonka.Types Methods showsPrec :: Int -> Region -> ShowS # show :: Region -> String # showList :: [Region] -> ShowS #
IsString Region Source #
Instance details Defined in Amazonka.Types Methods fromString :: String -> Region #
Generic Region Source #
Instance details Defined in Amazonka.Types Associated Types type Rep Region :: Type -> Type # Methods from :: Region -> Rep Region x # to :: Rep Region x -> Region #
NFData Region Source #
Instance details Defined in Amazonka.Types Methods rnf :: Region -> () #
Hashable Region Source #
Instance details Defined in Amazonka.Types Methods hashWithSalt :: Int -> Region -> Int # hash :: Region -> Int #
ToJSON Region Source #
Instance details Defined in Amazonka.Types Methods toJSON :: Region -> Value # toEncoding :: Region -> Encoding # toJSONList :: [Region] -> Value # toEncodingList :: [Region] -> Encoding #
FromJSON Region Source #
Instance details Defined in Amazonka.Types Methods parseJSON :: Value -> Parser Region # parseJSONList :: Value -> Parser [Region] #
ToText Region Source #
Instance details Defined in Amazonka.Types Methods toText :: Region -> Text Source #
FromText Region Source #
Instance details Defined in Amazonka.Types Methods fromText :: Text -> Either String Region Source #
ToByteString Region Source #
Instance details Defined in Amazonka.Types Methods toBS :: Region -> ByteString Source #
ToXML Region Source #
Instance details Defined in Amazonka.Types Methods toXML :: Region -> XML Source #
FromXML Region Source #
Instance details Defined in Amazonka.Types Methods parseXML :: [Node] -> Either String Region Source #
ToQuery Region Source #
Instance details Defined in Amazonka.Types Methods toQuery :: Region -> QueryString Source #
ToLog Region Source #
Instance details Defined in Amazonka.Types Methods build :: Region -> ByteStringBuilder Source #
type Rep Region Source #
Instance details Defined in Amazonka.Types type Rep Region = D1 ('MetaData "Region" "Amazonka.Types" "libZSamazonka-coreZSamazonka-core" 'True) (C1 ('MetaCons "Region'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromRegion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

Endpoints

data Endpoint Source #

Constructors

Endpoint
Fields _endpointHost :: ByteString _endpointSecure :: Bool _endpointPort :: Int _endpointScope :: ByteString

Instances

Instances details

Eq Endpoint Source #
Instance details Defined in Amazonka.Types Methods (==) :: Endpoint -> Endpoint -> Bool # (/=) :: Endpoint -> Endpoint -> Bool #
Show Endpoint Source #
Instance details Defined in Amazonka.Types Methods showsPrec :: Int -> Endpoint -> ShowS # show :: Endpoint -> String # showList :: [Endpoint] -> ShowS #

endpointHost :: Lens' Endpoint ByteString Source #

endpointPort :: Lens' Endpoint Int Source #

endpointSecure :: Lens' Endpoint Bool Source #

endpointScope :: Lens' Endpoint ByteString Source #

HTTP

type ClientRequest = Request Source #

A convenience alias to avoid type ambiguity.

type ClientResponse = Response Source #

A convenience alias encapsulating the common Response.

type ClientBody = ConduitM () ByteString (ResourceT IO) () Source #

A convenience alias encapsulating the common Response body.

newClientRequest :: Endpoint -> Maybe Seconds -> ClientRequest Source #

Construct a ClientRequest using common parameters such as TLS and prevent throwing errors when receiving erroneous status codes in respones.

Seconds

newtype Seconds Source #

An integral value representing seconds.

Constructors

Seconds Int

Instances

Instances details

Bounded Seconds Source #
Instance details Defined in Amazonka.Types Methods minBound :: Seconds # maxBound :: Seconds #
Enum Seconds Source #
Instance details Defined in Amazonka.Types Methods succ :: Seconds -> Seconds # pred :: Seconds -> Seconds # toEnum :: Int -> Seconds # fromEnum :: Seconds -> Int # enumFrom :: Seconds -> [Seconds] # enumFromThen :: Seconds -> Seconds -> [Seconds] # enumFromTo :: Seconds -> Seconds -> [Seconds] # enumFromThenTo :: Seconds -> Seconds -> Seconds -> [Seconds] #
Eq Seconds Source #
Instance details Defined in Amazonka.Types Methods (==) :: Seconds -> Seconds -> Bool # (/=) :: Seconds -> Seconds -> Bool #
Integral Seconds Source #
Instance details Defined in Amazonka.Types Methods quot :: Seconds -> Seconds -> Seconds # rem :: Seconds -> Seconds -> Seconds # div :: Seconds -> Seconds -> Seconds # mod :: Seconds -> Seconds -> Seconds # quotRem :: Seconds -> Seconds -> (Seconds, Seconds) # divMod :: Seconds -> Seconds -> (Seconds, Seconds) # toInteger :: Seconds -> Integer #
Num Seconds Source #
Instance details Defined in Amazonka.Types Methods (+) :: Seconds -> Seconds -> Seconds # (-) :: Seconds -> Seconds -> Seconds # (*) :: Seconds -> Seconds -> Seconds # negate :: Seconds -> Seconds # abs :: Seconds -> Seconds # signum :: Seconds -> Seconds # fromInteger :: Integer -> Seconds #
Ord Seconds Source #
Instance details Defined in Amazonka.Types Methods compare :: Seconds -> Seconds -> Ordering # (<) :: Seconds -> Seconds -> Bool # (<=) :: Seconds -> Seconds -> Bool # (>) :: Seconds -> Seconds -> Bool # (>=) :: Seconds -> Seconds -> Bool # max :: Seconds -> Seconds -> Seconds # min :: Seconds -> Seconds -> Seconds #
Read Seconds Source #
Instance details Defined in Amazonka.Types Methods readsPrec :: Int -> ReadS Seconds # readList :: ReadS [Seconds] # readPrec :: ReadPrec Seconds # readListPrec :: ReadPrec [Seconds] #
Real Seconds Source #
Instance details Defined in Amazonka.Types Methods toRational :: Seconds -> Rational #
Show Seconds Source #
Instance details Defined in Amazonka.Types Methods showsPrec :: Int -> Seconds -> ShowS # show :: Seconds -> String # showList :: [Seconds] -> ShowS #
Generic Seconds Source #
Instance details Defined in Amazonka.Types Associated Types type Rep Seconds :: Type -> Type # Methods from :: Seconds -> Rep Seconds x # to :: Rep Seconds x -> Seconds #
NFData Seconds Source #
Instance details Defined in Amazonka.Types Methods rnf :: Seconds -> () #
Hashable Seconds Source #
Instance details Defined in Amazonka.Types Methods hashWithSalt :: Int -> Seconds -> Int # hash :: Seconds -> Int #
ToText Seconds Source #
Instance details Defined in Amazonka.Types Methods toText :: Seconds -> Text Source #
FromText Seconds Source #
Instance details Defined in Amazonka.Types Methods fromText :: Text -> Either String Seconds Source #
ToByteString Seconds Source #
Instance details Defined in Amazonka.Types Methods toBS :: Seconds -> ByteString Source #
ToQuery Seconds Source #
Instance details Defined in Amazonka.Types Methods toQuery :: Seconds -> QueryString Source #
ToLog Seconds Source #
Instance details Defined in Amazonka.Types Methods build :: Seconds -> ByteStringBuilder Source #
type Rep Seconds Source #
Instance details Defined in Amazonka.Types type Rep Seconds = D1 ('MetaData "Seconds" "Amazonka.Types" "libZSamazonka-coreZSamazonka-core" 'True) (C1 ('MetaCons "Seconds" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int)))

toSeconds :: Seconds -> Int Source #

toMicroseconds :: Seconds -> Int Source #