Copyright	(c) 2013-2023 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	Safe-Inferred
Language	Haskell2010

Amazonka.Types

Contents

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

Description

Synopsis

newtype AccessKey = AccessKey ByteString
newtype SecretKey = SecretKey ByteString
newtype SessionToken = SessionToken ByteString
_AccessKey :: Iso' AccessKey ByteString
_SecretKey :: Iso' SecretKey ByteString
_SessionToken :: Iso' SessionToken ByteString
data Auth
- = Ref ThreadId (IORef AuthEnv)
- | Auth AuthEnv
withAuth :: MonadIO m => Auth -> (AuthEnv -> m a) -> m a
data AuthEnv = AuthEnv {
- accessKeyId :: AccessKey
- secretAccessKey :: Sensitive SecretKey
- sessionToken :: Maybe (Sensitive SessionToken)
- expiration :: Maybe ISO8601
}
authEnv_accessKeyId :: Lens' AuthEnv AccessKey
authEnv_secretAccessKey :: Lens' AuthEnv (Sensitive SecretKey)
authEnv_sessionToken :: Lens' AuthEnv (Maybe (Sensitive SessionToken))
authEnv_expiration :: Lens' AuthEnv (Maybe ISO8601)
type Algorithm a = Request a -> AuthEnv -> Region -> UTCTime -> Signed a
data Meta where
- Meta :: ToLog a => a -> Meta
data Signer = Signer {
- sign :: forall a. Algorithm a
- presign :: forall a. Seconds -> Algorithm a
}
data Signed a = Signed {
- signedMeta :: Meta
- signedRequest :: ClientRequest
}
signed_signedMeta :: Lens' (Signed a) Meta
signed_signedRequest :: Lens' (Signed a) ClientRequest
data Abbrev
data Service = Service {
- abbrev :: Abbrev
- signer :: Signer
- signingName :: ByteString
- version :: ByteString
- s3AddressingStyle :: S3AddressingStyle
- endpointPrefix :: ByteString
- endpoint :: Region -> Endpoint
- timeout :: Maybe Seconds
- check :: Status -> Bool
- error :: Status -> [Header] -> ByteStringLazy -> Error
- retry :: Retry
}
data S3AddressingStyle
- = S3AddressingStyleAuto
- | S3AddressingStylePath
- | S3AddressingStyleVirtual
_Abbrev :: Iso' Abbrev Text
service_abbrev :: Lens' Service Abbrev
service_signer :: Lens' Service Signer
service_signingName :: Lens' Service ByteString
service_version :: Lens' Service ByteString
service_s3AddressingStyle :: Lens' Service S3AddressingStyle
service_endpointPrefix :: Lens' Service ByteString
service_endpoint :: Lens' Service (Region -> Endpoint)
service_timeout :: Lens' Service (Maybe Seconds)
service_check :: Lens' Service (Status -> Bool)
service_error :: Lens' Service (Status -> [Header] -> ByteStringLazy -> Error)
service_retry :: Lens' Service Retry
class AWSRequest a where
- type AWSResponse a :: Type
- request :: (Service -> Service) -> a -> Request a
- response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy a -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse a)))
data Request a = Request {
- service :: Service
- method :: StdMethod
- path :: RawPath
- query :: QueryString
- headers :: [Header]
- body :: RequestBody
}
requestSign :: Algorithm a
requestPresign :: Seconds -> Algorithm a
requestUnsigned :: Request a -> Region -> ClientRequest
request_service :: Lens' (Request a) Service
request_method :: Lens' (Request a) StdMethod
request_path :: Lens' (Request a) RawPath
request_query :: Lens' (Request a) QueryString
request_headers :: forall a. Lens' (Request a) [Header]
request_body :: forall a. Lens' (Request a) RequestBody
data Retry = Exponential {
- base :: Double
- growth :: Int
- attempts :: Int
- check :: ServiceError -> Maybe Text
}
retry_base :: Lens' Retry Double
retry_growth :: Lens' Retry Int
retry_attempts :: Lens' Retry Int
retry_check :: 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' {
- abbrev :: Abbrev
- status :: Status
- body :: Maybe ByteStringLazy
- message :: String
}
serializeError_abbrev :: Lens' SerializeError Abbrev
serializeError_status :: Lens' SerializeError Status
serializeError_body :: Lens' SerializeError (Maybe ByteStringLazy)
serializeError_message :: Lens' SerializeError String
data ServiceError = ServiceError' {
- abbrev :: Abbrev
- status :: Status
- headers :: [Header]
- code :: ErrorCode
- message :: Maybe ErrorMessage
- requestId :: Maybe RequestId
}
serviceError_abbrev :: Lens' ServiceError Abbrev
serviceError_status :: Lens' ServiceError Status
serviceError_headers :: Lens' ServiceError [Header]
serviceError_code :: Lens' ServiceError ErrorCode
serviceError_message :: Lens' ServiceError (Maybe ErrorMessage)
serviceError_requestId :: Lens' ServiceError (Maybe RequestId)
newtype ErrorCode = ErrorCode Text
newErrorCode :: Text -> ErrorCode
newtype ErrorMessage = ErrorMessage {
- fromErrorMessage :: Text
}
newtype RequestId = RequestId {
- fromRequestId :: Text
}
_ErrorCode :: Iso' ErrorCode Text
_ErrorMessage :: Iso' ErrorMessage Text
_RequestId :: Iso' RequestId Text
newtype Region where
- Region' {
  - fromRegion :: Text
  }
- pattern Ohio :: Region
- pattern NorthVirginia :: Region
- pattern NorthCalifornia :: Region
- pattern Oregon :: Region
- pattern CapeTown :: Region
- pattern HongKong :: Region
- pattern Hyderabad :: Region
- pattern Jakarta :: Region
- pattern Melbourne :: Region
- pattern Mumbai :: Region
- pattern Osaka :: Region
- pattern Seoul :: Region
- pattern Singapore :: Region
- pattern Sydney :: Region
- pattern Tokyo :: Region
- pattern Montreal :: Region
- pattern Frankfurt :: Region
- pattern Ireland :: Region
- pattern London :: Region
- pattern Milan :: Region
- pattern Paris :: Region
- pattern Spain :: Region
- pattern Stockholm :: Region
- pattern Zurich :: Region
- pattern Bahrain :: Region
- pattern UAE :: Region
- pattern SaoPaulo :: Region
- pattern GovCloudEast :: Region
- pattern GovCloudWest :: Region
- pattern Beijing :: Region
- pattern Ningxia :: Region
data Endpoint = Endpoint {
- host :: ByteString
- basePath :: RawPath
- secure :: Bool
- port :: Int
- scope :: ByteString
}
endpoint_host :: Lens' Endpoint ByteString
endpoint_basePath :: Lens' Endpoint RawPath
endpoint_secure :: Lens' Endpoint Bool
endpoint_port :: Lens' Endpoint Int
endpoint_scope :: Lens' Endpoint ByteString
type ClientRequest = Request
type ClientResponse = Response
type ClientBody = ConduitM () ByteString (ResourceT IO) ()
newClientRequest :: Endpoint -> Maybe Seconds -> ClientRequest
newtype Seconds = Seconds DiffTime
toSeconds :: Seconds -> DiffTime
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

FromJSON AccessKey Source #
Instance details Defined in Amazonka.Types Methods parseJSON :: Value -> Parser AccessKey # parseJSONList :: Value -> Parser [AccessKey] #
ToJSON AccessKey Source #
Instance details Defined in Amazonka.Types Methods toJSON :: AccessKey -> Value # toEncoding :: AccessKey -> Encoding # toJSONList :: [AccessKey] -> Value # toEncodingList :: [AccessKey] -> Encoding #
ToByteString AccessKey Source #
Instance details Defined in Amazonka.Types Methods toBS :: AccessKey -> ByteString Source #
ToLog AccessKey Source #
Instance details Defined in Amazonka.Types Methods build :: AccessKey -> ByteStringBuilder Source #
ToQuery AccessKey Source #
Instance details Defined in Amazonka.Types Methods toQuery :: AccessKey -> QueryString Source #
FromText AccessKey Source #
Instance details Defined in Amazonka.Types Methods fromText :: Text -> Either String AccessKey Source #
ToText AccessKey Source #
Instance details Defined in Amazonka.Types Methods toText :: AccessKey -> Text Source #
FromXML AccessKey Source #
Instance details Defined in Amazonka.Types Methods parseXML :: [Node] -> Either String AccessKey Source #
ToXML AccessKey Source #
Instance details Defined in Amazonka.Types Methods toXML :: AccessKey -> XML Source #
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 #
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 #
NFData AccessKey Source #
Instance details Defined in Amazonka.Types Methods rnf :: AccessKey -> () #
Eq AccessKey Source #
Instance details Defined in Amazonka.Types Methods (==) :: AccessKey -> AccessKey -> Bool # (/=) :: AccessKey -> AccessKey -> Bool #
Hashable AccessKey Source #
Instance details Defined in Amazonka.Types Methods hashWithSalt :: Int -> AccessKey -> Int # hash :: AccessKey -> Int #
type Rep AccessKey Source #
Instance details Defined in Amazonka.Types type Rep AccessKey = D1 ('MetaData "AccessKey" "Amazonka.Types" "amazonka-core-2.0-BFuA7FRvuklLoYhn4b6A6p" '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

FromJSON SecretKey Source #
Instance details Defined in Amazonka.Types Methods parseJSON :: Value -> Parser SecretKey # parseJSONList :: Value -> Parser [SecretKey] #
ToJSON SecretKey Source #
Instance details Defined in Amazonka.Types Methods toJSON :: SecretKey -> Value # toEncoding :: SecretKey -> Encoding # toJSONList :: [SecretKey] -> Value # toEncodingList :: [SecretKey] -> Encoding #
ToByteString SecretKey Source #
Instance details Defined in Amazonka.Types Methods toBS :: SecretKey -> ByteString Source #
FromText SecretKey Source #
Instance details Defined in Amazonka.Types Methods fromText :: Text -> Either String SecretKey Source #
ToText SecretKey Source #
Instance details Defined in Amazonka.Types Methods toText :: SecretKey -> Text Source #
FromXML SecretKey Source #
Instance details Defined in Amazonka.Types Methods parseXML :: [Node] -> Either String SecretKey Source #
ToXML SecretKey Source #
Instance details Defined in Amazonka.Types Methods toXML :: SecretKey -> XML Source #
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 -> () #
Eq SecretKey Source #
Instance details Defined in Amazonka.Types Methods (==) :: SecretKey -> SecretKey -> Bool # (/=) :: SecretKey -> SecretKey -> Bool #
Hashable SecretKey Source #
Instance details Defined in Amazonka.Types Methods hashWithSalt :: Int -> SecretKey -> Int # hash :: SecretKey -> Int #
type Rep SecretKey Source #
Instance details Defined in Amazonka.Types type Rep SecretKey = D1 ('MetaData "SecretKey" "Amazonka.Types" "amazonka-core-2.0-BFuA7FRvuklLoYhn4b6A6p" '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

FromJSON SessionToken Source #
Instance details Defined in Amazonka.Types Methods parseJSON :: Value -> Parser SessionToken # parseJSONList :: Value -> Parser [SessionToken] #
ToJSON SessionToken Source #
Instance details Defined in Amazonka.Types Methods toJSON :: SessionToken -> Value # toEncoding :: SessionToken -> Encoding # toJSONList :: [SessionToken] -> Value # toEncodingList :: [SessionToken] -> Encoding #
ToByteString SessionToken Source #
Instance details Defined in Amazonka.Types Methods toBS :: SessionToken -> ByteString Source #
FromText SessionToken Source #
Instance details Defined in Amazonka.Types Methods fromText :: Text -> Either String SessionToken Source #
ToText SessionToken Source #
Instance details Defined in Amazonka.Types Methods toText :: SessionToken -> Text Source #
FromXML SessionToken Source #
Instance details Defined in Amazonka.Types Methods parseXML :: [Node] -> Either String SessionToken Source #
ToXML SessionToken Source #
Instance details Defined in Amazonka.Types Methods toXML :: SessionToken -> XML Source #
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 -> () #
Eq SessionToken Source #
Instance details Defined in Amazonka.Types Methods (==) :: SessionToken -> SessionToken -> Bool # (/=) :: SessionToken -> SessionToken -> Bool #
Hashable SessionToken Source #
Instance details Defined in Amazonka.Types Methods hashWithSalt :: Int -> SessionToken -> Int # hash :: SessionToken -> Int #
type Rep SessionToken Source #
Instance details Defined in Amazonka.Types type Rep SessionToken = D1 ('MetaData "SessionToken" "Amazonka.Types" "amazonka-core-2.0-BFuA7FRvuklLoYhn4b6A6p" 'True) (C1 ('MetaCons "SessionToken" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ByteString)))

Optics

_AccessKey :: Iso' AccessKey ByteString Source #

_SecretKey :: Iso' SecretKey ByteString Source #

_SessionToken :: Iso' SessionToken ByteString Source #

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 accessKeyId :: AccessKey secretAccessKey :: Sensitive SecretKey sessionToken :: Maybe (Sensitive SessionToken) expiration :: Maybe ISO8601

Instances

Instances details

FromJSON AuthEnv Source #
Instance details Defined in Amazonka.Types Methods parseJSON :: Value -> Parser AuthEnv # parseJSONList :: Value -> Parser [AuthEnv] #
ToLog AuthEnv Source #
Instance details Defined in Amazonka.Types Methods build :: AuthEnv -> ByteStringBuilder Source #
FromXML AuthEnv Source #
Instance details Defined in Amazonka.Types Methods parseXML :: [Node] -> Either String AuthEnv Source #
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 #
Show AuthEnv Source #
Instance details Defined in Amazonka.Types Methods showsPrec :: Int -> AuthEnv -> ShowS # show :: AuthEnv -> String # showList :: [AuthEnv] -> ShowS #
NFData AuthEnv Source #
Instance details Defined in Amazonka.Types Methods rnf :: AuthEnv -> () #
Eq AuthEnv Source #
Instance details Defined in Amazonka.Types Methods (==) :: AuthEnv -> AuthEnv -> Bool # (/=) :: AuthEnv -> AuthEnv -> Bool #
type Rep AuthEnv Source #
Instance details Defined in Amazonka.Types type Rep AuthEnv = D1 ('MetaData "AuthEnv" "Amazonka.Types" "amazonka-core-2.0-BFuA7FRvuklLoYhn4b6A6p" 'False) (C1 ('MetaCons "AuthEnv" 'PrefixI 'True) ((S1 ('MetaSel ('Just "accessKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 AccessKey) :: S1 ('MetaSel ('Just "secretAccessKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive SecretKey))) :: (S1 ('MetaSel ('Just "sessionToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive SessionToken))) :*: S1 ('MetaSel ('Just "expiration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)))))

Lenses

authEnv_accessKeyId :: Lens' AuthEnv AccessKey Source #

authEnv_secretAccessKey :: Lens' AuthEnv (Sensitive SecretKey) Source #

authEnv_sessionToken :: Lens' AuthEnv (Maybe (Sensitive SessionToken)) Source #

authEnv_expiration :: Lens' AuthEnv (Maybe ISO8601) Source #

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 sign :: forall a. Algorithm a presign :: 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

Lenses

signed_signedMeta :: Lens' (Signed a) Meta Source #

signed_signedRequest :: Lens' (Signed a) ClientRequest Source #

Service

data Abbrev Source #

Abbreviated service name.

Instances

Instances details

FromJSON Abbrev Source #
Instance details Defined in Amazonka.Types Methods parseJSON :: Value -> Parser Abbrev # parseJSONList :: Value -> Parser [Abbrev] #
ToLog Abbrev Source #
Instance details Defined in Amazonka.Types Methods build :: Abbrev -> ByteStringBuilder Source #
FromText Abbrev Source #
Instance details Defined in Amazonka.Types Methods fromText :: Text -> Either String Abbrev Source #
ToText Abbrev Source #
Instance details Defined in Amazonka.Types Methods toText :: Abbrev -> Text Source #
FromXML Abbrev Source #
Instance details Defined in Amazonka.Types Methods parseXML :: [Node] -> Either String Abbrev Source #
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 #
Show Abbrev Source #
Instance details Defined in Amazonka.Types Methods showsPrec :: Int -> Abbrev -> ShowS # show :: Abbrev -> String # showList :: [Abbrev] -> ShowS #
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 #
type Rep Abbrev Source #
Instance details Defined in Amazonka.Types type Rep Abbrev = D1 ('MetaData "Abbrev" "Amazonka.Types" "amazonka-core-2.0-BFuA7FRvuklLoYhn4b6A6p" '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

abbrev :: Abbrev
signer :: Signer
signingName :: ByteString
version :: ByteString
s3AddressingStyle :: S3AddressingStyle
Only service bindings using the s3vhost request plugin (configured in the generator) will care about this field. It is ignored otherwise.
endpointPrefix :: ByteString
endpoint :: Region -> Endpoint
timeout :: Maybe Seconds
check :: Status -> Bool
error :: Status -> [Header] -> ByteStringLazy -> Error
retry :: 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" "amazonka-core-2.0-BFuA7FRvuklLoYhn4b6A6p" 'False) (C1 ('MetaCons "Service" 'PrefixI 'True) (((S1 ('MetaSel ('Just "abbrev") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Abbrev) :: S1 ('MetaSel ('Just "signer") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Signer)) :: (S1 ('MetaSel ('Just "signingName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ByteString) :: (S1 ('MetaSel ('Just "version") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ByteString) :: S1 ('MetaSel ('Just "s3AddressingStyle") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 S3AddressingStyle)))) :: ((S1 ('MetaSel ('Just "endpointPrefix") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ByteString) :: (S1 ('MetaSel ('Just "endpoint") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Region -> Endpoint)) :: S1 ('MetaSel ('Just "timeout") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Seconds)))) :: (S1 ('MetaSel ('Just "check") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Status -> Bool)) :: (S1 ('MetaSel ('Just "error") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Status -> [Header] -> ByteStringLazy -> Error)) :: S1 ('MetaSel ('Just "retry") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Retry))))))

data S3AddressingStyle Source #

When to rewrite S3 requests into virtual-hosted style.

Requests to S3 can be rewritten to access buckets by setting the Host: header, which allows you to point a CNAME record at an Amazon S3 Bucket.

Non-S3 object stores usually do not support this, which is usually the only time you'll need to change this.

See: Virtual hosting of buckets in the Amazon S3 User Guide.

See: Changing the Addressing Style for the corresponding option in Boto 3.

Constructors

S3AddressingStyleAuto	Rewrite S3 request paths only if they can be expressed as a DNS label. This is the default.
S3AddressingStylePath	Do not ever rewrite S3 request paths.
S3AddressingStyleVirtual	Force virtual hosted style rewrites without checking the bucket name.

Instances

Instances details

Generic S3AddressingStyle Source #
Instance details Defined in Amazonka.Types Associated Types type Rep S3AddressingStyle :: Type -> Type # Methods from :: S3AddressingStyle -> Rep S3AddressingStyle x # to :: Rep S3AddressingStyle x -> S3AddressingStyle #
Show S3AddressingStyle Source #
Instance details Defined in Amazonka.Types Methods showsPrec :: Int -> S3AddressingStyle -> ShowS # show :: S3AddressingStyle -> String # showList :: [S3AddressingStyle] -> ShowS #
Eq S3AddressingStyle Source #
Instance details Defined in Amazonka.Types Methods (==) :: S3AddressingStyle -> S3AddressingStyle -> Bool # (/=) :: S3AddressingStyle -> S3AddressingStyle -> Bool #
type Rep S3AddressingStyle Source #
Instance details Defined in Amazonka.Types type Rep S3AddressingStyle = D1 ('MetaData "S3AddressingStyle" "Amazonka.Types" "amazonka-core-2.0-BFuA7FRvuklLoYhn4b6A6p" 'False) (C1 ('MetaCons "S3AddressingStyleAuto" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "S3AddressingStylePath" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "S3AddressingStyleVirtual" 'PrefixI 'False) (U1 :: Type -> Type)))

Optics

_Abbrev :: Iso' Abbrev Text Source #

service_abbrev :: Lens' Service Abbrev Source #

service_signer :: Lens' Service Signer Source #

service_signingName :: Lens' Service ByteString Source #

service_version :: Lens' Service ByteString Source #

service_s3AddressingStyle :: Lens' Service S3AddressingStyle Source #

service_endpointPrefix :: Lens' Service ByteString Source #

service_endpoint :: Lens' Service (Region -> Endpoint) Source #

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

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

service_error :: Lens' Service (Status -> [Header] -> ByteStringLazy -> Error) Source #

service_retry :: Lens' Service Retry Source #

Requests

class AWSRequest a where Source #

Specify how a request can be de/serialised.

Associated Types

type AWSResponse a :: Type Source #

The successful, expected response associated with a request.

Methods

request Source #

Arguments

:: (Service -> Service)	Overrides applied to the default `Service`.
-> a
-> Request a

response Source #

Arguments

:: MonadResource m
=> (ByteStringLazy -> IO ByteStringLazy)	Raw response body hook.
-> Service
-> Proxy a
-> ClientResponse ClientBody
-> m (Either Error (ClientResponse (AWSResponse a)))

data Request a Source #

An unsigned request.

Constructors

Request
Fields service :: Service method :: StdMethod path :: RawPath query :: QueryString headers :: [Header] body :: 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" "amazonka-core-2.0-BFuA7FRvuklLoYhn4b6A6p" 'False) (C1 ('MetaCons "Request" 'PrefixI 'True) ((S1 ('MetaSel ('Just "service") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Service) :: (S1 ('MetaSel ('Just "method") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 StdMethod) :: S1 ('MetaSel ('Just "path") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 RawPath))) :: (S1 ('MetaSel ('Just "query") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 QueryString) :: (S1 ('MetaSel ('Just "headers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Header]) :*: S1 ('MetaSel ('Just "body") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 RequestBody)))))

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.

Lenses

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

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

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

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

request_headers :: forall a. Lens' (Request a) [Header] Source #

request_body :: forall a. Lens' (Request a) RequestBody Source #

Retries

data Retry Source #

Constants and predicates used to create a RetryPolicy.

Constructors

Exponential
Fields base :: Double growth :: Int attempts :: Int check :: 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" "amazonka-core-2.0-BFuA7FRvuklLoYhn4b6A6p" 'False) (C1 ('MetaCons "Exponential" 'PrefixI 'True) ((S1 ('MetaSel ('Just "base") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Double) :: S1 ('MetaSel ('Just "growth") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)) :: (S1 ('MetaSel ('Just "attempts") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "check") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (ServiceError -> Maybe Text)))))

Lenses

retry_base :: Lens' Retry Double Source #

retry_growth :: Lens' Retry Int Source #

retry_attempts :: Lens' Retry Int Source #

retry_check :: 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 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 #
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 #

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

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 #
Exception Error Source #
Instance details Defined in Amazonka.Types Methods toException :: Error -> SomeException # fromException :: SomeException -> Maybe Error # displayException :: Error -> String #
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 #
Show Error Source #
Instance details Defined in Amazonka.Types Methods showsPrec :: Int -> Error -> ShowS # show :: Error -> String # showList :: [Error] -> ShowS #
type Rep Error Source #
Instance details Defined in Amazonka.Types type Rep Error = D1 ('MetaData "Error" "Amazonka.Types" "amazonka-core-2.0-BFuA7FRvuklLoYhn4b6A6p" '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

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

Serialize Errors

data SerializeError Source #

Constructors

SerializeError'
Fields abbrev :: Abbrev status :: Status body :: Maybe ByteStringLazy The response body, if the response was not streaming. message :: String

Instances

Instances details

ToLog SerializeError Source #
Instance details Defined in Amazonka.Types Methods build :: SerializeError -> ByteStringBuilder Source #
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 #
Show SerializeError Source #
Instance details Defined in Amazonka.Types Methods showsPrec :: Int -> SerializeError -> ShowS # show :: SerializeError -> String # showList :: [SerializeError] -> ShowS #
Eq SerializeError Source #
Instance details Defined in Amazonka.Types Methods (==) :: SerializeError -> SerializeError -> Bool # (/=) :: SerializeError -> SerializeError -> Bool #
type Rep SerializeError Source #
Instance details Defined in Amazonka.Types type Rep SerializeError = D1 ('MetaData "SerializeError" "Amazonka.Types" "amazonka-core-2.0-BFuA7FRvuklLoYhn4b6A6p" 'False) (C1 ('MetaCons "SerializeError'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "abbrev") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Abbrev) :: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Status)) :: (S1 ('MetaSel ('Just "body") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ByteStringLazy)) :*: S1 ('MetaSel ('Just "message") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 String))))

Lenses

serializeError_abbrev :: Lens' SerializeError Abbrev Source #

serializeError_status :: Lens' SerializeError Status Source #

serializeError_body :: Lens' SerializeError (Maybe ByteStringLazy) Source #

serializeError_message :: Lens' SerializeError String Source #

Service Errors

data ServiceError Source #

Constructors

ServiceError'
Fields abbrev :: Abbrev status :: Status headers :: [Header] code :: ErrorCode message :: Maybe ErrorMessage requestId :: Maybe RequestId

Instances

Instances details

ToLog ServiceError Source #
Instance details Defined in Amazonka.Types Methods build :: ServiceError -> ByteStringBuilder Source #
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 #
Show ServiceError Source #
Instance details Defined in Amazonka.Types Methods showsPrec :: Int -> ServiceError -> ShowS # show :: ServiceError -> String # showList :: [ServiceError] -> ShowS #
Eq ServiceError Source #
Instance details Defined in Amazonka.Types Methods (==) :: ServiceError -> ServiceError -> Bool # (/=) :: ServiceError -> ServiceError -> Bool #
type Rep ServiceError Source #
Instance details Defined in Amazonka.Types type Rep ServiceError = D1 ('MetaData "ServiceError" "Amazonka.Types" "amazonka-core-2.0-BFuA7FRvuklLoYhn4b6A6p" 'False) (C1 ('MetaCons "ServiceError'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "abbrev") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Abbrev) :: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Status) :: S1 ('MetaSel ('Just "headers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Header]))) :: (S1 ('MetaSel ('Just "code") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ErrorCode) :: (S1 ('MetaSel ('Just "message") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ErrorMessage)) :*: S1 ('MetaSel ('Just "requestId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RequestId))))))

Lenses

serviceError_abbrev :: Lens' ServiceError Abbrev Source #

serviceError_status :: Lens' ServiceError Status Source #

serviceError_headers :: Lens' ServiceError [Header] Source #

serviceError_code :: Lens' ServiceError ErrorCode Source #

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

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

Error Types

newtype ErrorCode Source #

Constructors

ErrorCode Text

Instances

Instances details

FromJSON ErrorCode Source #
Instance details Defined in Amazonka.Types Methods parseJSON :: Value -> Parser ErrorCode # parseJSONList :: Value -> Parser [ErrorCode] #
ToLog ErrorCode Source #
Instance details Defined in Amazonka.Types Methods build :: ErrorCode -> ByteStringBuilder Source #
FromText ErrorCode Source #
Instance details Defined in Amazonka.Types Methods fromText :: Text -> Either String ErrorCode Source #
ToText ErrorCode Source #
Instance details Defined in Amazonka.Types Methods toText :: ErrorCode -> Text Source #
FromXML ErrorCode Source #
Instance details Defined in Amazonka.Types Methods parseXML :: [Node] -> Either String ErrorCode Source #
IsString ErrorCode Source #
Instance details Defined in Amazonka.Types Methods fromString :: String -> ErrorCode #
Show ErrorCode Source #
Instance details Defined in Amazonka.Types Methods showsPrec :: Int -> ErrorCode -> ShowS # show :: ErrorCode -> String # showList :: [ErrorCode] -> ShowS #
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 #

newErrorCode :: Text -> ErrorCode Source #

Construct an ErrorCode.

newtype ErrorMessage Source #

Constructors

ErrorMessage
Fields fromErrorMessage :: Text

Instances

Instances details

FromJSON ErrorMessage Source #
Instance details Defined in Amazonka.Types Methods parseJSON :: Value -> Parser ErrorMessage # parseJSONList :: Value -> Parser [ErrorMessage] #
ToLog ErrorMessage Source #
Instance details Defined in Amazonka.Types Methods build :: ErrorMessage -> ByteStringBuilder Source #
FromText ErrorMessage Source #
Instance details Defined in Amazonka.Types Methods fromText :: Text -> Either String ErrorMessage Source #
ToText ErrorMessage Source #
Instance details Defined in Amazonka.Types Methods toText :: ErrorMessage -> Text Source #
FromXML ErrorMessage Source #
Instance details Defined in Amazonka.Types Methods parseXML :: [Node] -> Either String ErrorMessage Source #
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 #
Show ErrorMessage Source #
Instance details Defined in Amazonka.Types Methods showsPrec :: Int -> ErrorMessage -> ShowS # show :: ErrorMessage -> String # showList :: [ErrorMessage] -> ShowS #
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 #
type Rep ErrorMessage Source #
Instance details Defined in Amazonka.Types type Rep ErrorMessage = D1 ('MetaData "ErrorMessage" "Amazonka.Types" "amazonka-core-2.0-BFuA7FRvuklLoYhn4b6A6p" '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

FromJSON RequestId Source #
Instance details Defined in Amazonka.Types Methods parseJSON :: Value -> Parser RequestId # parseJSONList :: Value -> Parser [RequestId] #
ToLog RequestId Source #
Instance details Defined in Amazonka.Types Methods build :: RequestId -> ByteStringBuilder Source #
FromText RequestId Source #
Instance details Defined in Amazonka.Types Methods fromText :: Text -> Either String RequestId Source #
ToText RequestId Source #
Instance details Defined in Amazonka.Types Methods toText :: RequestId -> Text Source #
FromXML RequestId Source #
Instance details Defined in Amazonka.Types Methods parseXML :: [Node] -> Either String RequestId Source #
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 #
Show RequestId Source #
Instance details Defined in Amazonka.Types Methods showsPrec :: Int -> RequestId -> ShowS # show :: RequestId -> String # showList :: [RequestId] -> ShowS #
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 #
type Rep RequestId Source #
Instance details Defined in Amazonka.Types type Rep RequestId = D1 ('MetaData "RequestId" "Amazonka.Types" "amazonka-core-2.0-BFuA7FRvuklLoYhn4b6A6p" 'True) (C1 ('MetaCons "RequestId" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromRequestId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

Optics

_ErrorCode :: Iso' ErrorCode Text Source #

_ErrorMessage :: Iso' ErrorMessage Text Source #

_RequestId :: Iso' RequestId Text Source #

Regions

newtype Region Source #

The available AWS regions.

Constructors

Region'
Fields fromRegion :: Text

Bundled Patterns

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

Instances

Instances details

FromJSON Region Source #
Instance details Defined in Amazonka.Types Methods parseJSON :: Value -> Parser Region # parseJSONList :: Value -> Parser [Region] #
ToJSON Region Source #
Instance details Defined in Amazonka.Types Methods toJSON :: Region -> Value # toEncoding :: Region -> Encoding # toJSONList :: [Region] -> Value # toEncodingList :: [Region] -> Encoding #
ToByteString Region Source #
Instance details Defined in Amazonka.Types Methods toBS :: Region -> ByteString Source #
ToLog Region Source #
Instance details Defined in Amazonka.Types Methods build :: Region -> ByteStringBuilder Source #
ToQuery Region Source #
Instance details Defined in Amazonka.Types Methods toQuery :: Region -> QueryString Source #
FromText Region Source #
Instance details Defined in Amazonka.Types Methods fromText :: Text -> Either String Region Source #
ToText Region Source #
Instance details Defined in Amazonka.Types Methods toText :: Region -> Text Source #
FromXML Region Source #
Instance details Defined in Amazonka.Types Methods parseXML :: [Node] -> Either String Region Source #
ToXML Region Source #
Instance details Defined in Amazonka.Types Methods toXML :: Region -> XML Source #
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 #
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 #
NFData Region Source #
Instance details Defined in Amazonka.Types Methods rnf :: Region -> () #
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 #
Hashable Region Source #
Instance details Defined in Amazonka.Types Methods hashWithSalt :: Int -> Region -> Int # hash :: Region -> Int #
type Rep Region Source #
Instance details Defined in Amazonka.Types type Rep Region = D1 ('MetaData "Region" "Amazonka.Types" "amazonka-core-2.0-BFuA7FRvuklLoYhn4b6A6p" 'True) (C1 ('MetaCons "Region'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromRegion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

Endpoints

data Endpoint Source #

Constructors

Endpoint

Fields

host :: ByteString
The host to make requests to. Usually something like s3.us-east-1.amazonaws.com.
basePath :: RawPath
Path segment prepended to the request path of any request made to this endpoint. This is useful if you want to use the AWS API Gateway Management API, which requires you to override the client endpoint including a leading path segment (either the stage or, on a custom domain, the mapped base path).
secure :: Bool
port :: Int
scope :: ByteString
Signing scope, usually a region like us-east-1.

Instances

Instances details

Generic Endpoint Source #
Instance details Defined in Amazonka.Types Associated Types type Rep Endpoint :: Type -> Type # Methods from :: Endpoint -> Rep Endpoint x # to :: Rep Endpoint x -> Endpoint #
Show Endpoint Source #
Instance details Defined in Amazonka.Types Methods showsPrec :: Int -> Endpoint -> ShowS # show :: Endpoint -> String # showList :: [Endpoint] -> ShowS #
Eq Endpoint Source #
Instance details Defined in Amazonka.Types Methods (==) :: Endpoint -> Endpoint -> Bool # (/=) :: Endpoint -> Endpoint -> Bool #
type Rep Endpoint Source #
Instance details Defined in Amazonka.Types type Rep Endpoint = D1 ('MetaData "Endpoint" "Amazonka.Types" "amazonka-core-2.0-BFuA7FRvuklLoYhn4b6A6p" 'False) (C1 ('MetaCons "Endpoint" 'PrefixI 'True) ((S1 ('MetaSel ('Just "host") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ByteString) :: S1 ('MetaSel ('Just "basePath") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 RawPath)) :: (S1 ('MetaSel ('Just "secure") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool) :: (S1 ('MetaSel ('Just "port") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :: S1 ('MetaSel ('Just "scope") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ByteString)))))

Lenses

endpoint_host :: Lens' Endpoint ByteString Source #

endpoint_basePath :: Lens' Endpoint RawPath Source #

endpoint_secure :: Lens' Endpoint Bool Source #

endpoint_port :: Lens' Endpoint Int Source #

endpoint_scope :: 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 #

A numeric value representing seconds.

Constructors

Seconds DiffTime

Instances

Instances details

ToByteString Seconds Source #
Instance details Defined in Amazonka.Types Methods toBS :: Seconds -> ByteString Source #
ToLog Seconds Source #
Instance details Defined in Amazonka.Types Methods build :: Seconds -> ByteStringBuilder Source #
ToQuery Seconds Source #
Instance details Defined in Amazonka.Types Methods toQuery :: Seconds -> QueryString Source #
FromText Seconds Source #
Instance details Defined in Amazonka.Types Methods fromText :: Text -> Either String Seconds Source #
ToText Seconds Source #
Instance details Defined in Amazonka.Types Methods toText :: Seconds -> Text Source #
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] #
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 #
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 #
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 #
NFData Seconds Source #
Instance details Defined in Amazonka.Types Methods rnf :: Seconds -> () #
Eq Seconds Source #
Instance details Defined in Amazonka.Types Methods (==) :: Seconds -> Seconds -> Bool # (/=) :: Seconds -> Seconds -> Bool #
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 #
Hashable Seconds Source #
Instance details Defined in Amazonka.Types Methods hashWithSalt :: Int -> Seconds -> Int # hash :: Seconds -> Int #
type Rep Seconds Source #
Instance details Defined in Amazonka.Types type Rep Seconds = D1 ('MetaData "Seconds" "Amazonka.Types" "amazonka-core-2.0-BFuA7FRvuklLoYhn4b6A6p" 'True) (C1 ('MetaCons "Seconds" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 DiffTime)))

toSeconds :: Seconds -> DiffTime Source #

toMicroseconds :: Seconds -> Int Source #