Amazonka

This module provides simple Env and IO-based operations which can be performed against remote Amazon Web Services APIs, for use with the types supplied by the various amazonka-* libraries.

Usage

The key functions dealing with the request/response lifecycle are:

• send, sendEither
• paginate, paginateEither
• await, awaitEither

These functions have constraints that types from the amazonka-* libraries satisfy. To utilise these, you will need to specify what Region you wish to operate in and your Amazon credentials for AuthN/AuthZ purposes.

Credentials can be supplied in a number of ways. Either via explicit keys, via session profiles, or have Amazonka retrieve the credentials from an underlying IAM Role/Profile.

As a basic example, you might wish to store an object in an S3 bucket using amazonka-s3:

{-# LANGUAGE OverloadedStrings #-}

import qualified Amazonka as AWS
import qualified Amazonka.S3 as S3
import qualified System.IO as IO

example :: IO S3.PutObjectResponse
example = do
    -- A new Logger to replace the default noop logger is created, with the logger
    -- set to print debug information and errors to stdout:
    logger <- AWS.newLogger AWS.Debug IO.stdout

    -- To specify configuration preferences, newEnv is used to create a new
    -- configuration environment. The argument to newEnv is used to specify the
    -- mechanism for supplying or retrieving AuthN/AuthZ information.
    -- In this case discover will cause the library to try a number of options such
    -- as default environment variables, or an instance's IAM Profile and identity document:
    discoveredEnv <- AWS.newEnv AWS.discover

    let env =
            discoveredEnv
                { AWS.logger = logger
                , AWS.region = AWS.Frankfurt
                }

    -- The payload (and hash) for the S3 object is retrieved from a FilePath,
    -- either hashedFile or chunkedFile can be used, with the latter ensuring
    -- the contents of the file is enumerated exactly once, during send:
    body <- AWS.chunkedFile AWS.defaultChunkSize "local/path/to/object-payload"

    -- We now run the AWS computation with the overriden logger, performing the
    -- PutObject request.
    AWS.runResourceT $
        AWS.send env (S3.newPutObject "bucket-name" "object-key" body)

Authentication and Environment

type Env = Env' Identity

An environment with auth credentials. Most AWS requests need one of these, and you can create one with newEnv.

type EnvNoAuth = Env' Proxy

An environment with no auth credentials. Used for certain requests which need to be unsigned, like sts:AssumeRoleWithWebIdentity, and you can create one with newEnvNoAuth if you need it.

data Env' withAuth

The environment containing the parameters required to make AWS requests.

This type tracks whether or not we have credentials at the type level, to avoid "presigning" requests when we lack auth information.

Constructors

Env

Fields

• region :: Region
• logger :: Logger
• hooks :: ~Hooks
• retryCheck :: Int -> HttpException -> Bool
• overrides :: Service -> Service
• manager :: Manager
• auth :: withAuth Auth

Instances

Generic (Env' withAuth)

Defined in Amazonka.Env

Associated Types

type Rep (Env' withAuth) :: Type -> Type

Methods

from :: Env' withAuth -> Rep (Env' withAuth) x

to :: Rep (Env' withAuth) x -> Env' withAuth

type Rep (Env' withAuth)

Defined in Amazonka.Env

type Rep (Env' withAuth) = D1 ('MetaData "Env'" "Amazonka.Env" "amazonka-2.0-48plDWnPMAk3PGO79vdSa0" 'False) (C1 ('MetaCons "Env" 'PrefixI 'True) ((S1 ('MetaSel ('Just "region") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Region) :*: (S1 ('MetaSel ('Just "logger") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Logger) :*: S1 ('MetaSel ('Just "hooks") 'NoSourceUnpackedness 'SourceLazy 'DecidedLazy) (Rec0 Hooks))) :*: ((S1 ('MetaSel ('Just "retryCheck") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Int -> HttpException -> Bool)) :*: S1 ('MetaSel ('Just "overrides") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Service -> Service))) :*: (S1 ('MetaSel ('Just "manager") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Manager) :*: S1 ('MetaSel ('Just "auth") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (withAuth Auth))))))

newEnv

Arguments

:: MonadIO m

=> (EnvNoAuth -> m Env)

Credential discovery mechanism, often discover.

-> m Env

Creates a new environment with a new Manager without debug logging and uses the provided function to expand/discover credentials. Record updates or lenses can be used to further configure the resulting Env.

Since: 1.5.0 - The region is now retrieved from the AWS_REGION environment variable (identical to official SDKs), or defaults to us-east-1. You can override the Env region by updating its $sel:region:Env field.

Since: 1.3.6 - The default logic for retrying HttpExceptions now uses retryConnectionFailure to retry specific connection failure conditions up to 3 times. Previously only service specific errors were automatically retried. This can be reverted to the old behaviour by resetting the Env's $sel:retryCheck:Env field to (\_ _ -> False).

Throws AuthError when environment variables or IAM profiles cannot be read.

See: newEnvFromManager.

newEnvFromManager

Arguments

:: MonadIO m

=> Manager

-> (EnvNoAuth -> m Env)

Credential discovery mechanism.

-> m Env

Creates a new environment, but with an existing Manager.

newEnvNoAuth :: MonadIO m => m EnvNoAuth

Generate an environment without credentials, which may only make unsigned requests. Sets the region based on the AWS_REGION environment variable, or NorthVirginia if unset.

This lets us support calls like the sts:AssumeRoleWithWebIdentity operation, which needs to make an unsigned request to pass the token from an identity provider.

newEnvNoAuthFromManager :: MonadIO m => Manager -> m EnvNoAuth

Generate an environment without credentials, passing in an explicit Manager.

authMaybe :: Foldable withAuth => Env' withAuth -> Maybe Auth

Get "the" Auth from an Env', if we can.

Service Configuration

When a request is sent, various values such as the endpoint, retry strategy, timeout and error handlers are taken from the associated Service for a request. For example, DynamoDB will use the defaultService configuration when sending PutItem, Query and all other operations.

You can modify a specific Service's default configuration by using configureService. To modify all configurations simultaneously, see overrideService.

An example of how you might alter default configuration using these mechanisms is demonstrated below. Firstly, the default dynamoDB service is configured to use non-SSL localhost as the endpoint:

import qualified Amazonka as AWS
import qualified Amazonka.DynamoDB as DynamoDB

let dynamo :: AWS.Service
    dynamo = AWS.setEndpoint False "localhost" 8000 DynamoDB.defaultService

The updated configuration is then passed to the Env during setup:

env <- AWS.configureService dynamo <$> AWS.newEnv AWS.discover

AWS.runResourceT $ do
    -- This S3 operation will communicate with remote AWS APIs.
    x <- AWS.send env newListBuckets

    -- DynamoDB operations will communicate with localhost:8000.
    y <- AWS.send env Dynamo.newListTables

    -- Any operations for services other than DynamoDB, are not affected.
    ...

You can also scope the service configuration modifications to specific actions:

env <- AWS.newEnv AWS.discover

AWS.runResourceT $ do
    -- Service operations here will communicate with AWS, even remote DynamoDB.
    x <- AWS.send env Dynamo.newListTables

    -- Here DynamoDB operations will communicate with localhost:8000.
    y <- AWS.send (AWS.configure dynamo env) Dynamo.newListTables

Functions such as once and globalTimeout can also be used to modify service configuration for all (or specific) requests.

overrideService :: (Service -> Service) -> Env' withAuth -> Env' withAuth

Provide a function which will be added to the existing stack of overrides applied to all service configurations.

configureService :: Service -> Env' withAuth -> Env' withAuth

Configure a specific service. All requests belonging to the supplied service will use this configuration instead of the default.

It's suggested you modify the default service configuration, such as Amazonka.DynamoDB.defaultService.

globalTimeout :: Seconds -> Env' withAuth -> Env' withAuth

Override the timeout value for this Env.

Default timeouts are chosen by considering:

• This timeout, if set.
• The related Service timeout for the sent request if set. (Usually 70s)
• The $sel:manager:Env timeout if set.
• The default ClientRequest timeout. (Approximately 30s)

once :: Env' withAuth -> Env' withAuth

Disable any retry logic for an Env, so that any requests will at most be sent once.

Running AWS Actions

runResourceT :: MonadUnliftIO m => ResourceT m a -> m a

Unwrap a ResourceT transformer, and call all registered release actions.

Note that there is some reference counting involved due to resourceForkIO. If multiple threads are sharing the same collection of resources, only the last call to runResourceT will deallocate the resources.

NOTE Since version 1.2.0, this function will throw a ResourceCleanupException if any of the cleanup functions throw an exception.

Since: resourcet-0.3.0

Credential Discovery

AuthN/AuthZ information is handled similarly to other AWS SDKs. You can read some of the options available here.

discover should be your default way of requesting credentials, as it searches the standard places that the official AWS SDKs use.

Authentication methods which return short-lived credentials (e.g., when running on an EC2 instance) fork a background thread which transparently handles the expiry and subsequent refresh of IAM profile information. See fetchAuthInBackground for more information.

See: Amazonka.Auth, if you want to commit to specific authentication methods.

See: runCredentialChain if you want to build your own credential chain.

newtype AccessKey

An access key ID.

For example: AKIAIOSFODNN7EXAMPLE

See: Understanding and Getting Your Security Credentials.

Constructors

AccessKey ByteString

Instances

FromJSON AccessKey

Defined in Amazonka.Types

Methods

parseJSON :: Value -> Parser AccessKey

parseJSONList :: Value -> Parser [AccessKey]

ToJSON AccessKey

Defined in Amazonka.Types

Methods

toJSON :: AccessKey -> Value

toEncoding :: AccessKey -> Encoding

toJSONList :: [AccessKey] -> Value

toEncodingList :: [AccessKey] -> Encoding

ToByteString AccessKey

Defined in Amazonka.Types

Methods

toBS :: AccessKey -> ByteString

ToLog AccessKey

Defined in Amazonka.Types

Methods

build :: AccessKey -> ByteStringBuilder

ToQuery AccessKey

Defined in Amazonka.Types

Methods

toQuery :: AccessKey -> QueryString

FromText AccessKey

Defined in Amazonka.Types

Methods

fromText :: Text -> Either String AccessKey

ToText AccessKey

Defined in Amazonka.Types

Methods

toText :: AccessKey -> Text

FromXML AccessKey

Defined in Amazonka.Types

Methods

parseXML :: [Node] -> Either String AccessKey

ToXML AccessKey

Defined in Amazonka.Types

Methods

toXML :: AccessKey -> XML

IsString AccessKey

Defined in Amazonka.Types

Methods

fromString :: String -> AccessKey

Generic AccessKey

Defined in Amazonka.Types

Associated Types

type Rep AccessKey :: Type -> Type

Methods

from :: AccessKey -> Rep AccessKey x

to :: Rep AccessKey x -> AccessKey

Read AccessKey

Defined in Amazonka.Types

Methods

readsPrec :: Int -> ReadS AccessKey

readList :: ReadS [AccessKey]

readPrec :: ReadPrec AccessKey

readListPrec :: ReadPrec [AccessKey]

Show AccessKey

Defined in Amazonka.Types

Methods

showsPrec :: Int -> AccessKey -> ShowS

show :: AccessKey -> String

showList :: [AccessKey] -> ShowS

NFData AccessKey

Defined in Amazonka.Types

Methods

rnf :: AccessKey -> ()

Eq AccessKey

Defined in Amazonka.Types

Methods

(==) :: AccessKey -> AccessKey -> Bool

(/=) :: AccessKey -> AccessKey -> Bool

Hashable AccessKey

Defined in Amazonka.Types

Methods

hashWithSalt :: Int -> AccessKey -> Int

hash :: AccessKey -> Int

type Rep AccessKey

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

Secret access key credential.

For example: wJalrXUtnFEMIK7MDENGbPxRfiCYEXAMPLEKE

See: Understanding and Getting Your Security Credentials.

Constructors

SecretKey ByteString

Instances

FromJSON SecretKey

Defined in Amazonka.Types

Methods

parseJSON :: Value -> Parser SecretKey

parseJSONList :: Value -> Parser [SecretKey]

ToJSON SecretKey

Defined in Amazonka.Types

Methods

toJSON :: SecretKey -> Value

toEncoding :: SecretKey -> Encoding

toJSONList :: [SecretKey] -> Value

toEncodingList :: [SecretKey] -> Encoding

ToByteString SecretKey

Defined in Amazonka.Types

Methods

toBS :: SecretKey -> ByteString

FromText SecretKey

Defined in Amazonka.Types

Methods

fromText :: Text -> Either String SecretKey

ToText SecretKey

Defined in Amazonka.Types

Methods

toText :: SecretKey -> Text

FromXML SecretKey

Defined in Amazonka.Types

Methods

parseXML :: [Node] -> Either String SecretKey

ToXML SecretKey

Defined in Amazonka.Types

Methods

toXML :: SecretKey -> XML

IsString SecretKey

Defined in Amazonka.Types

Methods

fromString :: String -> SecretKey

Generic SecretKey

Defined in Amazonka.Types

Associated Types

type Rep SecretKey :: Type -> Type

Methods

from :: SecretKey -> Rep SecretKey x

to :: Rep SecretKey x -> SecretKey

NFData SecretKey

Defined in Amazonka.Types

Methods

rnf :: SecretKey -> ()

Eq SecretKey

Defined in Amazonka.Types

Methods

(==) :: SecretKey -> SecretKey -> Bool

(/=) :: SecretKey -> SecretKey -> Bool

Hashable SecretKey

Defined in Amazonka.Types

Methods

hashWithSalt :: Int -> SecretKey -> Int

hash :: SecretKey -> Int

type Rep SecretKey

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

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

See: Temporary Security Credentials.

Constructors

SessionToken ByteString

Instances

FromJSON SessionToken

Defined in Amazonka.Types

Methods

parseJSON :: Value -> Parser SessionToken

parseJSONList :: Value -> Parser [SessionToken]

ToJSON SessionToken

Defined in Amazonka.Types

Methods

toJSON :: SessionToken -> Value

toEncoding :: SessionToken -> Encoding

toJSONList :: [SessionToken] -> Value

toEncodingList :: [SessionToken] -> Encoding

ToByteString SessionToken

Defined in Amazonka.Types

Methods

toBS :: SessionToken -> ByteString

FromText SessionToken

Defined in Amazonka.Types

Methods

fromText :: Text -> Either String SessionToken

ToText SessionToken

Defined in Amazonka.Types

Methods

toText :: SessionToken -> Text

FromXML SessionToken

Defined in Amazonka.Types

Methods

parseXML :: [Node] -> Either String SessionToken

ToXML SessionToken

Defined in Amazonka.Types

Methods

toXML :: SessionToken -> XML

IsString SessionToken

Defined in Amazonka.Types

Methods

fromString :: String -> SessionToken

Generic SessionToken

Defined in Amazonka.Types

Associated Types

type Rep SessionToken :: Type -> Type

Methods

from :: SessionToken -> Rep SessionToken x

to :: Rep SessionToken x -> SessionToken

NFData SessionToken

Defined in Amazonka.Types

Methods

rnf :: SessionToken -> ()

Eq SessionToken

Defined in Amazonka.Types

Methods

(==) :: SessionToken -> SessionToken -> Bool

(/=) :: SessionToken -> SessionToken -> Bool

Hashable SessionToken

Defined in Amazonka.Types

Methods

hashWithSalt :: Int -> SessionToken -> Int

hash :: SessionToken -> Int

type Rep SessionToken

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)))

discover :: (MonadCatch m, MonadIO m, Foldable withAuth) => Env' withAuth -> m Env

Attempt to fetch credentials in a way similar to the official AWS SDKs. The C++ SDK lists the following sequence:

• Check environment variables for keys provided directly (AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY, optionally AWS_SESSION_TOKEN)
• Check credentials/config files for authentication information, respecting the AWS_PROFILE environment variable.
• Exchange a Web Identity for AWS Credentials using sts:AssumeRoleWithWebIdentity, respecting the AWS_WEB_IDENTITY_TOKEN_FILE, AWS_ROLE_ARN, and optionally the AWS_ROLE_SESSION_NAME environment variables.
• Retrieve credentials from the ECS Container Agent if the AWS_CONTAINER_CREDENTIALS_RELATIVE_URI environment variable is set.

• If we think we're running on EC2, retrieve the first available IAM profile from the instance identity document, and use this to set the Placement. We attempt to resolve http://instance-data rather than directly retrieving http://169.254.169.254 for IAM profile information. This ensures that the DNS lookup terminates promptly if not running on EC2, but means that your VPC must have enableDnsSupport and enableDnsHostnames set.

  NOTE: This is not 100% consistent with the AWS SDKs, which does not attempt to query the ECS service if either AWS_CONTAINER_CREDENTIALS_RELATIVE_URI or AWS_CONTAINER_CREDENTIALS_FULL_URI are set.

  See: https://docs.aws.amazon.com/AWSJavaSDK/latest/javadoc/com/amazonaws/auth/EC2ContainerCredentialsProviderWrapper.html

Supported Regions

newtype Region

The available AWS regions.

Constructors

Region'

Fields

• fromRegion :: Text

Bundled Patterns

pattern Ningxia :: Region

pattern Beijing :: Region

pattern GovCloudWest :: Region

pattern GovCloudEast :: Region

pattern SaoPaulo :: Region

pattern UAE :: Region

pattern Bahrain :: Region

pattern Zurich :: Region

pattern Stockholm :: Region

pattern Spain :: Region

pattern Paris :: Region

pattern Milan :: Region

pattern London :: Region

pattern Ireland :: Region

pattern Frankfurt :: Region

pattern Montreal :: Region

pattern Tokyo :: Region

pattern Sydney :: Region

pattern Singapore :: Region

pattern Seoul :: Region

pattern Osaka :: Region

pattern Mumbai :: Region

pattern Melbourne :: Region

pattern Jakarta :: Region

pattern Hyderabad :: Region

pattern HongKong :: Region

pattern CapeTown :: Region

pattern Oregon :: Region

pattern NorthCalifornia :: Region

pattern NorthVirginia :: Region

pattern Ohio :: Region

Instances

FromJSON Region

Defined in Amazonka.Types

Methods

parseJSON :: Value -> Parser Region

parseJSONList :: Value -> Parser [Region]

ToJSON Region

Defined in Amazonka.Types

Methods

toJSON :: Region -> Value

toEncoding :: Region -> Encoding

toJSONList :: [Region] -> Value

toEncodingList :: [Region] -> Encoding

ToByteString Region

Defined in Amazonka.Types

Methods

toBS :: Region -> ByteString

ToLog Region

Defined in Amazonka.Types

Methods

build :: Region -> ByteStringBuilder

ToQuery Region

Defined in Amazonka.Types

Methods

toQuery :: Region -> QueryString

FromText Region

Defined in Amazonka.Types

Methods

fromText :: Text -> Either String Region

ToText Region

Defined in Amazonka.Types

Methods

toText :: Region -> Text

FromXML Region

Defined in Amazonka.Types

Methods

parseXML :: [Node] -> Either String Region

ToXML Region

Defined in Amazonka.Types

Methods

toXML :: Region -> XML

IsString Region

Defined in Amazonka.Types

Methods

fromString :: String -> Region

Generic Region

Defined in Amazonka.Types

Associated Types

type Rep Region :: Type -> Type

Methods

from :: Region -> Rep Region x

to :: Rep Region x -> Region

Read Region

Defined in Amazonka.Types

Methods

readsPrec :: Int -> ReadS Region

readList :: ReadS [Region]

readPrec :: ReadPrec Region

readListPrec :: ReadPrec [Region]

Show Region

Defined in Amazonka.Types

Methods

showsPrec :: Int -> Region -> ShowS

show :: Region -> String

showList :: [Region] -> ShowS

NFData Region

Defined in Amazonka.Types

Methods

rnf :: Region -> ()

Eq Region

Defined in Amazonka.Types

Methods

(==) :: Region -> Region -> Bool

(/=) :: Region -> Region -> Bool

Ord Region

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

Defined in Amazonka.Types

Methods

hashWithSalt :: Int -> Region -> Int

hash :: Region -> Int

type Rep Region

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)))

Service Endpoints

data Endpoint

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

Generic Endpoint

Defined in Amazonka.Types

Associated Types

type Rep Endpoint :: Type -> Type

Methods

from :: Endpoint -> Rep Endpoint x

to :: Rep Endpoint x -> Endpoint

Show Endpoint

Defined in Amazonka.Types

Methods

showsPrec :: Int -> Endpoint -> ShowS

show :: Endpoint -> String

showList :: [Endpoint] -> ShowS

Eq Endpoint

Defined in Amazonka.Types

Methods

(==) :: Endpoint -> Endpoint -> Bool

(/=) :: Endpoint -> Endpoint -> Bool

type Rep Endpoint

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)))))

setEndpoint

Arguments

:: Bool

Whether to use HTTPS (ie. SSL).

-> ByteString

The hostname to connect to.

-> Int

The port number to connect to.

-> Service

The service configuration to override.

-> Service

A convenience function for overriding the Service Endpoint.

See: $sel:endpoint:Service.

Sending Requests

To send a request you need to create a value of the desired operation type using the relevant constructor, as well as any further modifications of default/optional parameters using the appropriate lenses. This value can then be sent using send or paginate and the library will take care of serialisation/authentication and so forth.

The default Service configuration for a request contains retry configuration that is used to determine if a request can safely be retried and what kind of back off/on strategy should be used. (Usually exponential.) Typically services define retry strategies that handle throttling, general server errors and transport errors. Streaming requests are never retried.

send :: (MonadResource m, AWSRequest a, Typeable a, Typeable (AWSResponse a)) => Env -> a -> m (AWSResponse a)

Send a request, returning the associated response if successful.

Errors are thrown in IO.

See sendEither.

sendEither :: (MonadResource m, AWSRequest a, Typeable a, Typeable (AWSResponse a)) => Env -> a -> m (Either Error (AWSResponse a))

Send a request, returning the associated response if successful.

See send.

Pagination

Some AWS operations return results that are incomplete and require subsequent requests in order to obtain the entire result set. The process of sending subsequent requests to continue where a previous request left off is called pagination. For example, the ListObjects operation of Amazon S3 returns up to 1000 objects at a time, and you must send subsequent requests with the appropriate Marker in order to retrieve the next page of results.

Operations that have an AWSPager instance can transparently perform subsequent requests, correctly setting markers and other request facets to iterate through the entire result set of a truncated API operation. Operations which support this have an additional note in the documentation.

Many operations have the ability to filter results on the server side. See the individual operation parameters for details.

paginate :: (MonadResource m, AWSPager a, Typeable a, Typeable (AWSResponse a)) => Env -> a -> ConduitM () (AWSResponse a) m ()

Repeatedly send a request, automatically setting markers and performing pagination. Exits on the first encountered error.

Errors are thrown in IO.

See paginateEither.

paginateEither :: (MonadResource m, AWSPager a, Typeable a, Typeable (AWSResponse a)) => Env -> a -> ConduitM () (AWSResponse a) m (Either Error ())

Repeatedly send a request, automatically setting markers and performing pagination.

Exits on the first encountered error.

See paginate.

Waiters

Waiters poll by repeatedly sending a request until some remote success condition configured by the Wait specification is fulfilled. The Wait specification determines how many attempts should be made, in addition to delay and retry strategies. Error conditions that are not handled by the Wait configuration will be thrown, or the first successful response that fulfills the success condition will be returned.

Wait specifications can be found under the Amazonka.{ServiceName}.Waiters namespace for services which support await.

await :: (MonadResource m, AWSRequest a, Typeable a) => Env -> Wait a -> a -> m Accept

Poll the API with the supplied request until a specific Wait condition is fulfilled.

Errors are thrown in IO.

See awaitEither.

awaitEither :: (MonadResource m, AWSRequest a, Typeable a) => Env -> Wait a -> a -> m (Either Error Accept)

Poll the API with the supplied request until a specific Wait condition is fulfilled.

See await.

Unsigned

sendUnsigned :: (MonadResource m, AWSRequest a, Typeable a, Typeable (AWSResponse a)) => Env' withAuth -> a -> m (AWSResponse a)

Make an unsigned request, returning the associated response if successful.

Errors are thrown in IO.

See sendUnsignedEither.

sendUnsignedEither :: (MonadResource m, AWSRequest a, Typeable a, Typeable (AWSResponse a)) => Env' withAuth -> a -> m (Either Error (AWSResponse a))

Make a request without signing it. You will almost never need to do this, but some authentication methods (e.g. sts:AssumeRoleWithWebIdentity and sso:GetRoleCredentials) require you to exchange a token using an unsigned request. Amazonka's support for these authentication methods calls sendUnsigned, and we re-export these functions in case you need to support similar authentication methods in your code.

See sendUnsigned.

Streaming

Streaming comes in two flavours. HashedBody represents a request that requires a precomputed SHA256 hash, or a ChunkedBody type for those services that can perform incremental signing and do not require the entire payload to be hashed (such as S3). The type signatures for request smart constructors advertise which respective body type is required, denoting the underlying signing capabilities.

ToHashedBody and ToBody typeclass instances are available to construct the streaming bodies, automatically calculating any hash or size as needed for types such as Text, ByteString, or Aeson's Value type. To read files and other IO primitives, functions such as hashedFile, chunkedFile, or hashedBody should be used.

For responses that contain streaming bodies (such as GetObject), you can use sinkBody to connect the response body to a conduit-compatible sink.

class ToBody a where

Anything that can be converted to a streaming request Body.

Minimal complete definition

Nothing

Methods

toBody :: a -> RequestBody

Convert a value to a request body.

Instances

ToBody Value

Defined in Amazonka.Data.Body

Methods

toBody :: Value -> RequestBody

ToBody Base64

Defined in Amazonka.Data.Base64

Methods

toBody :: Base64 -> RequestBody

ToBody ChunkedBody

Defined in Amazonka.Data.Body

Methods

toBody :: ChunkedBody -> RequestBody

ToBody HashedBody

Defined in Amazonka.Data.Body

Methods

toBody :: HashedBody -> RequestBody

ToBody RequestBody

Defined in Amazonka.Data.Body

Methods

toBody :: RequestBody -> RequestBody

ToBody QueryString

Defined in Amazonka.Data.Body

Methods

toBody :: QueryString -> RequestBody

ToBody ByteStringLazy

Defined in Amazonka.Data.Body

Methods

toBody :: ByteStringLazy -> RequestBody

ToBody TextLazy

Defined in Amazonka.Data.Body

Methods

toBody :: TextLazy -> RequestBody

ToBody ByteString

Defined in Amazonka.Data.Body

Methods

toBody :: ByteString -> RequestBody

ToBody Text

Defined in Amazonka.Data.Body

Methods

toBody :: Text -> RequestBody

ToBody Element

Defined in Amazonka.Data.Body

Methods

toBody :: Element -> RequestBody

ToBody String

Defined in Amazonka.Data.Body

Methods

toBody :: String -> RequestBody

ToBody (KeyMap Value)

Defined in Amazonka.Data.Body

Methods

toBody :: KeyMap Value -> RequestBody

ToBody a => ToBody (Sensitive a)

Defined in Amazonka.Data.Sensitive

Methods

toBody :: Sensitive a -> RequestBody

ToHashedBody a => ToBody (Maybe a)

Defined in Amazonka.Data.Body

Methods

toBody :: Maybe a -> RequestBody

data RequestBody

Invariant: only services that support both standard and chunked signing expose RequestBody as a parameter.

Constructors

Chunked ChunkedBody

Currently S3 only, see ChunkedBody for details.

Hashed HashedBody

Instances

ToBody RequestBody

Defined in Amazonka.Data.Body

Methods

toBody :: RequestBody -> RequestBody

IsString RequestBody

Defined in Amazonka.Data.Body

Methods

fromString :: String -> RequestBody

Show RequestBody

Defined in Amazonka.Data.Body

Methods

showsPrec :: Int -> RequestBody -> ShowS

show :: RequestBody -> String

showList :: [RequestBody] -> ShowS

newtype ResponseBody

A streaming, exception safe response body.

newtype for show/orhpan instance purposes.

Constructors

ResponseBody

Fields

• body :: ConduitM () ByteString (ResourceT IO) ()

Instances

Generic ResponseBody

Defined in Amazonka.Data.Body

Associated Types

type Rep ResponseBody :: Type -> Type

Methods

from :: ResponseBody -> Rep ResponseBody x

to :: Rep ResponseBody x -> ResponseBody

Show ResponseBody

Defined in Amazonka.Data.Body

Methods

showsPrec :: Int -> ResponseBody -> ShowS

show :: ResponseBody -> String

showList :: [ResponseBody] -> ShowS

type Rep ResponseBody

Defined in Amazonka.Data.Body

type Rep ResponseBody = D1 ('MetaData "ResponseBody" "Amazonka.Data.Body" "amazonka-core-2.0-BFuA7FRvuklLoYhn4b6A6p" 'True) (C1 ('MetaCons "ResponseBody" 'PrefixI 'True) (S1 ('MetaSel ('Just "body") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (ConduitM () ByteString (ResourceT IO) ()))))

Hashed Request Bodies

class ToHashedBody a where

Anything that can be safely converted to a HashedBody.

Methods

toHashed :: a -> HashedBody

Convert a value to a hashed request body.

Instances

ToHashedBody Value

Defined in Amazonka.Data.Body

Methods

toHashed :: Value -> HashedBody

ToHashedBody Base64

Defined in Amazonka.Data.Base64

Methods

toHashed :: Base64 -> HashedBody

ToHashedBody HashedBody

Defined in Amazonka.Data.Body

Methods

toHashed :: HashedBody -> HashedBody

ToHashedBody QueryString

Defined in Amazonka.Data.Body

Methods

toHashed :: QueryString -> HashedBody

ToHashedBody ByteStringLazy

Defined in Amazonka.Data.Body

Methods

toHashed :: ByteStringLazy -> HashedBody

ToHashedBody TextLazy

Defined in Amazonka.Data.Body

Methods

toHashed :: TextLazy -> HashedBody

ToHashedBody ByteString

Defined in Amazonka.Data.Body

Methods

toHashed :: ByteString -> HashedBody

ToHashedBody Text

Defined in Amazonka.Data.Body

Methods

toHashed :: Text -> HashedBody

ToHashedBody Element

Defined in Amazonka.Data.Body

Methods

toHashed :: Element -> HashedBody

ToHashedBody String

Defined in Amazonka.Data.Body

Methods

toHashed :: String -> HashedBody

ToHashedBody (KeyMap Value)

Defined in Amazonka.Data.Body

Methods

toHashed :: KeyMap Value -> HashedBody

data HashedBody

An opaque request body containing a SHA256 hash.

Constructors

HashedStream (Digest SHA256) !Integer (ConduitM () ByteString (ResourceT IO) ())

HashedBytes (Digest SHA256) ByteString

Instances

ToBody HashedBody

Defined in Amazonka.Data.Body

Methods

toBody :: HashedBody -> RequestBody

ToHashedBody HashedBody

Defined in Amazonka.Data.Body

Methods

toHashed :: HashedBody -> HashedBody

IsString HashedBody

Defined in Amazonka.Data.Body

Methods

fromString :: String -> HashedBody

Show HashedBody

Defined in Amazonka.Data.Body

Methods

showsPrec :: Int -> HashedBody -> ShowS

show :: HashedBody -> String

showList :: [HashedBody] -> ShowS

hashedFile

Arguments

:: MonadIO m

=> FilePath

The file path to read.

-> m HashedBody

Construct a HashedBody from a FilePath, calculating the SHA256 hash and file size.

Note: While this function will perform in constant space, it will enumerate the entirety of the file contents twice. Firstly to calculate the SHA256 and lastly to stream the contents to the socket during sending.

See: ToHashedBody.

hashedFileRange

Arguments

:: MonadIO m

=> FilePath

The file path to read.

-> Integer

The byte offset at which to start reading.

-> Integer

The maximum number of bytes to read.

-> m HashedBody

Construct a HashedBody from a FilePath, specifying the range of bytes to read. This can be useful for constructing multiple requests from a single file, say for S3 multipart uploads.

See: hashedFile, sourceFileRange.

hashedBody

Arguments

:: Digest SHA256

A SHA256 hash of the file contents.

-> Integer

The size of the stream in bytes.

-> ConduitM () ByteString (ResourceT IO) ()

-> HashedBody

Construct a HashedBody from a Source, manually specifying the SHA256 hash and file size. It's left up to the caller to calculate these correctly, otherwise AWS will return signing errors.

See: ToHashedBody.

Chunked Request Bodies

data ChunkedBody

An opaque request body which will be transmitted via Transfer-Encoding: chunked.

Invariant: Only services that support chunked encoding can accept a ChunkedBody. (Currently S3.) This is enforced by the type signatures emitted by the generator.

Constructors

ChunkedBody

Fields

• size :: ChunkSize
• length :: Integer
• body :: ConduitM () ByteString (ResourceT IO) ()

Instances

ToBody ChunkedBody

Defined in Amazonka.Data.Body

Methods

toBody :: ChunkedBody -> RequestBody

Show ChunkedBody

Defined in Amazonka.Data.Body

Methods

showsPrec :: Int -> ChunkedBody -> ShowS

show :: ChunkedBody -> String

showList :: [ChunkedBody] -> ShowS

newtype ChunkSize

Specifies the transmitted size of the 'Transfer-Encoding' chunks.

See: defaultChunk.

Constructors

ChunkSize Int

Instances

ToLog ChunkSize

Defined in Amazonka.Data.Body

Methods

build :: ChunkSize -> ByteStringBuilder

Enum ChunkSize

Defined in Amazonka.Data.Body

Methods

succ :: ChunkSize -> ChunkSize

pred :: ChunkSize -> ChunkSize

toEnum :: Int -> ChunkSize

fromEnum :: ChunkSize -> Int

enumFrom :: ChunkSize -> [ChunkSize]

enumFromThen :: ChunkSize -> ChunkSize -> [ChunkSize]

enumFromTo :: ChunkSize -> ChunkSize -> [ChunkSize]

enumFromThenTo :: ChunkSize -> ChunkSize -> ChunkSize -> [ChunkSize]

Num ChunkSize

Defined in Amazonka.Data.Body

Methods

(+) :: ChunkSize -> ChunkSize -> ChunkSize

(-) :: ChunkSize -> ChunkSize -> ChunkSize

(*) :: ChunkSize -> ChunkSize -> ChunkSize

negate :: ChunkSize -> ChunkSize

abs :: ChunkSize -> ChunkSize

signum :: ChunkSize -> ChunkSize

fromInteger :: Integer -> ChunkSize

Integral ChunkSize

Defined in Amazonka.Data.Body

Methods

quot :: ChunkSize -> ChunkSize -> ChunkSize

rem :: ChunkSize -> ChunkSize -> ChunkSize

div :: ChunkSize -> ChunkSize -> ChunkSize

mod :: ChunkSize -> ChunkSize -> ChunkSize

quotRem :: ChunkSize -> ChunkSize -> (ChunkSize, ChunkSize)

divMod :: ChunkSize -> ChunkSize -> (ChunkSize, ChunkSize)

toInteger :: ChunkSize -> Integer

Real ChunkSize

Defined in Amazonka.Data.Body

Methods

toRational :: ChunkSize -> Rational

Show ChunkSize

Defined in Amazonka.Data.Body

Methods

showsPrec :: Int -> ChunkSize -> ShowS

show :: ChunkSize -> String

showList :: [ChunkSize] -> ShowS

Eq ChunkSize

Defined in Amazonka.Data.Body

Methods

(==) :: ChunkSize -> ChunkSize -> Bool

(/=) :: ChunkSize -> ChunkSize -> Bool

Ord ChunkSize

Defined in Amazonka.Data.Body

Methods

compare :: ChunkSize -> ChunkSize -> Ordering

(<) :: ChunkSize -> ChunkSize -> Bool

(<=) :: ChunkSize -> ChunkSize -> Bool

(>) :: ChunkSize -> ChunkSize -> Bool

(>=) :: ChunkSize -> ChunkSize -> Bool

max :: ChunkSize -> ChunkSize -> ChunkSize

min :: ChunkSize -> ChunkSize -> ChunkSize

defaultChunkSize :: ChunkSize

The default chunk size of 128 KB. The minimum chunk size accepted by AWS is 8 KB, unless the entirety of the request is below this threshold.

A chunk size of 64 KB or higher is recommended for performance reasons.

chunkedFile :: MonadIO m => ChunkSize -> FilePath -> m RequestBody

Construct a ChunkedBody from a FilePath, where the contents will be read and signed incrementally in chunks if the target service supports it.

Will intelligently revert to HashedBody if the file is smaller than the specified ChunkSize.

See: ToBody.

chunkedFileRange

Arguments

:: MonadIO m

=> ChunkSize

The idealized size of chunks that will be yielded downstream.

-> FilePath

The file path to read.

-> Integer

The byte offset at which to start reading.

-> Integer

The maximum number of bytes to read.

-> m RequestBody

Construct a ChunkedBody from a FilePath, specifying the range of bytes to read. This can be useful for constructing multiple requests from a single file, say for S3 multipart uploads.

See: chunkedFile.

unsafeChunkedBody

Arguments

:: ChunkSize

The idealized size of chunks that will be yielded downstream.

-> Integer

The size of the stream in bytes.

-> ConduitM () ByteString (ResourceT IO) ()

-> RequestBody

Unsafely construct a ChunkedBody.

This function is marked unsafe because it does nothing to enforce the chunk size. Typically for conduit IO functions, it's whatever ByteString's defaultBufferSize is, around 32 KB. If the chunk size is less than 8 KB, the request will error. 64 KB or higher chunk size is recommended for performance reasons.

Note that it will always create a chunked body even if the request is too small.

See: ToBody.

Response Bodies

sinkBody :: MonadIO m => ResponseBody -> ConduitM ByteString Void (ResourceT IO) a -> m a

Connect a Sink to a response stream.

File Size and MD5/SHA256

getFileSize :: MonadIO m => FilePath -> m Integer

Convenience function for obtaining the size of a file.

sinkMD5 :: forall (m :: Type -> Type) o. Monad m => ConduitM ByteString o m (Digest MD5)

Incrementally calculate a MD5 Digest.

sinkSHA256 :: forall (m :: Type -> Type) o. Monad m => ConduitM ByteString o m (Digest SHA256)

Incrementally calculate a SHA256 Digest.

Presigning Requests

Presigning requires the Service signer to be an instance of AWSPresigner. Not all signing algorithms support this.

presignURL

Arguments

:: (MonadIO m, AWSRequest a)

=> Env

-> UTCTime

Signing time.

-> Seconds

Expiry time.

-> a

Request to presign.

-> m ByteString

Presign an URL that is valid from the specified time until the number of seconds expiry has elapsed.

presign

Arguments

:: (MonadIO m, AWSRequest a)

=> Env

-> UTCTime

Signing time.

-> Seconds

Expiry time.

-> a

Request to presign.

-> m ClientRequest

Presign an HTTP request that is valid from the specified time until the number of seconds expiry has elapsed.

Running Asynchronous Actions

Requests can be sent asynchronously, but due to guarantees about resource closure require the use of UnliftIO.Async.

The following example demonstrates retrieving two objects from S3 concurrently:

{-# LANGUAGE OverloadedStrings #-}
import qualified Amazonka as AWS
import qualified Amazonka.S3 as S3
import qualified UnliftIO.Async as Async

let requestA = S3.newGetObject "bucket" "prefix/object-a"
let requestB = S3.newGetObject "bucket" "prefix/object-b"

runResourceT $
  Async.withAsync (send env requestA) $ \asyncA ->
    Async.withAsync (send env requestB) $ \asyncB -> do
      Async.waitBoth asyncA asyncB

If you are running many async requests in parallel, using ContT can hide the giant callback pyramid:

runResourceT . evalContT $ do
  asyncA <- ContT $ Async.withAsync (send env requestA)
  asyncB <- ContT $ Async.withAsync (send env requestB)
  Async.waitBoth asyncA asyncB

Handling Errors

Errors are either returned or thrown by the library using IO. Sub-errors of the canonical LogLevel type can be caught using trying or catching and the appropriate AsError Prism when using the non-Either send variants:

trying _Error          (send $ newListObjects "bucket-name") :: Either Error          ListObjectsResponse
trying _TransportError (send $ newListObjects "bucket-name") :: Either HttpException  ListObjectsResponse
trying _SerializeError (send $ newListObjects "bucket-name") :: Either SerializeError ListObjectsResponse
trying _ServiceError   (send $ newListObjects "bucket-name") :: Either ServiceError   ListObjectsResponse

Many of the individual amazonka-* libraries export compatible Folds for matching service specific error codes and messages in the style above. See the Error Matchers heading in each respective library for details.

class AsError a where

Minimal complete definition

_Error

Methods

_Error :: Prism' a Error

A general Amazonka error.

_TransportError :: Prism' a HttpException

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

_SerializeError :: Prism' a SerializeError

A serialisation error occured when attempting to deserialise a response.

_ServiceError :: Prism' a ServiceError

A service specific error returned by the remote service.

Instances

AsError Error

Defined in Amazonka.Types

Methods

_Error :: Prism' Error Error

_TransportError :: Prism' Error HttpException

_SerializeError :: Prism' Error SerializeError

_ServiceError :: Prism' Error ServiceError

AsError SomeException

Defined in Amazonka.Types

Methods

_Error :: Prism' SomeException Error

_TransportError :: Prism' SomeException HttpException

_SerializeError :: Prism' SomeException SerializeError

_ServiceError :: Prism' SomeException ServiceError

class AsAuthError a where

Minimal complete definition

_AuthError

Methods

_AuthError :: Prism' a AuthError

A general authentication error.

_RetrievalError :: Prism' a HttpException

An error occured while communicating over HTTP with the local metadata endpoint.

_MissingEnvError :: Prism' a Text

The named environment variable was not found.

_MissingFileError :: Prism' a FilePath

The specified credentials file could not be found.

_InvalidFileError :: Prism' a Text

An error occured parsing the credentials file.

_InvalidIAMError :: Prism' a Text

The specified IAM profile could not be found or deserialised.

Instances

AsAuthError AuthError

Defined in Amazonka.Auth.Exception

Methods

_AuthError :: Prism' AuthError AuthError

_RetrievalError :: Prism' AuthError HttpException

_MissingEnvError :: Prism' AuthError Text

_MissingFileError :: Prism' AuthError FilePath

_InvalidFileError :: Prism' AuthError Text

_InvalidIAMError :: Prism' AuthError Text

AsAuthError SomeException

Defined in Amazonka.Auth.Exception

Methods

_AuthError :: Prism' SomeException AuthError

_RetrievalError :: Prism' SomeException HttpException

_MissingEnvError :: Prism' SomeException Text

_MissingFileError :: Prism' SomeException FilePath

_InvalidFileError :: Prism' SomeException Text

_InvalidIAMError :: Prism' SomeException Text

trying :: MonadCatch m => Getting (First a) SomeException a -> m r -> m (Either a r)

A variant of try that takes a ReifiedPrism (or any ReifiedFold) to select which exceptions are caught (c.f. tryJust, catchJust). If the Exception does not match the predicate, it is re-thrown.

trying :: MonadCatch m => Prism'     SomeException a -> m r -> m (Either a r)
trying :: MonadCatch m => Lens'      SomeException a -> m r -> m (Either a r)
trying :: MonadCatch m => Traversal' SomeException a -> m r -> m (Either a r)
trying :: MonadCatch m => Iso'       SomeException a -> m r -> m (Either a r)
trying :: MonadCatch m => ReifiedGetter     SomeException a -> m r -> m (Either a r)
trying :: MonadCatch m => ReifiedFold       SomeException a -> m r -> m (Either a r)

catching :: MonadCatch m => Getting (First a) SomeException a -> m r -> (a -> m r) -> m r

Catch exceptions that match a given ReifiedPrism (or any ReifiedFold, really).

>>> catching _AssertionFailed (assert False (return "uncaught")) $ \ _ -> return "caught"
"caught"

catching :: MonadCatch m => Prism' SomeException a     -> m r -> (a -> m r) -> m r
catching :: MonadCatch m => Lens' SomeException a      -> m r -> (a -> m r) -> m r
catching :: MonadCatch m => Traversal' SomeException a -> m r -> (a -> m r) -> m r
catching :: MonadCatch m => Iso' SomeException a       -> m r -> (a -> m r) -> m r
catching :: MonadCatch m => ReifiedGetter SomeException a     -> m r -> (a -> m r) -> m r
catching :: MonadCatch m => ReifiedFold SomeException a       -> m r -> (a -> m r) -> m r

Building Error Prisms

_MatchServiceError :: AsError a => Service -> ErrorCode -> Fold a ServiceError

Provides a generalised prism for catching a specific service error identified by the opaque service abbreviation and error code.

This can be used if the generated error prisms provided by Amazonka.ServiceName.Types do not cover all the thrown error codes. For example to define a new error prism:

{-# LANGUAGE OverloadedStrings #-}

import Amazonka.S3 (ServiceError, s3)

_NoSuchBucketPolicy :: AsError a => Fold a ServiceError
_NoSuchBucketPolicy = _MatchServiceError s3 "NoSuchBucketPolicy"

With example usage being:

>>> import Control.Exception.Lens (trying)
>>> :t trying _NoSuchBucketPolicy
MonadCatch m => m a -> m (Either ServiceError a)

hasService :: (Applicative f, Choice p) => Service -> Optic' p f ServiceError ServiceError

hasStatus :: (Applicative f, Choice p) => Int -> Optic' p f ServiceError ServiceError

hasCode :: (Applicative f, Choice p) => ErrorCode -> Optic' p f ServiceError ServiceError

Logging

The exposed logging interface is a primitive Logger function which the hooks system calls throughout the request/response process. This allows the library to output useful information and diagnostics.

The newLogger function can be used to construct a simple logger which writes output to a Handle, but in most production code you should probably consider using a more robust logging library such as tinylog or fast-logger.

data LogLevel

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

ToByteString LogLevel

Defined in Amazonka.Logger

Methods

toBS :: LogLevel -> ByteString

FromText LogLevel

Defined in Amazonka.Logger

Methods

fromText :: Text -> Either String LogLevel

ToText LogLevel

Defined in Amazonka.Logger

Methods

toText :: LogLevel -> Text

Enum LogLevel

Defined in Amazonka.Logger

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]

Generic LogLevel

Defined in Amazonka.Logger

Associated Types

type Rep LogLevel :: Type -> Type

Methods

from :: LogLevel -> Rep LogLevel x

to :: Rep LogLevel x -> LogLevel

Show LogLevel

Defined in Amazonka.Logger

Methods

showsPrec :: Int -> LogLevel -> ShowS

show :: LogLevel -> String

showList :: [LogLevel] -> ShowS

Eq LogLevel

Defined in Amazonka.Logger

Methods

(==) :: LogLevel -> LogLevel -> Bool

(/=) :: LogLevel -> LogLevel -> Bool

Ord LogLevel

Defined in Amazonka.Logger

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

type Rep LogLevel

Defined in Amazonka.Logger

type Rep LogLevel = D1 ('MetaData "LogLevel" "Amazonka.Logger" "amazonka-2.0-48plDWnPMAk3PGO79vdSa0" '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 ()

A logging function called by various default hooks to log informational and debug messages.

Constructing a Logger

newLogger :: MonadIO m => LogLevel -> Handle -> m Logger

This is a primitive logger which can be used to log builds to a Handle.

Note: A more sophisticated logging library such as tinylog or fast-logger should be used in production code.

Re-exported Types

data UTCTime

This is the simplest representation of UTC. It consists of the day number, and a time offset from midnight. Note that if a day has a leap second added to it, it will have 86401 seconds.

Instances

FromJSON UTCTime

Defined in Data.Aeson.Types.FromJSON

Methods

parseJSON :: Value -> Parser UTCTime

parseJSONList :: Value -> Parser [UTCTime]

FromJSONKey UTCTime

Defined in Data.Aeson.Types.FromJSON

Methods

fromJSONKey :: FromJSONKeyFunction UTCTime

fromJSONKeyList :: FromJSONKeyFunction [UTCTime]

ToJSON UTCTime

Defined in Data.Aeson.Types.ToJSON

Methods

toJSON :: UTCTime -> Value

toEncoding :: UTCTime -> Encoding

toJSONList :: [UTCTime] -> Value

toEncodingList :: [UTCTime] -> Encoding

ToJSONKey UTCTime

Defined in Data.Aeson.Types.ToJSON

Methods

toJSONKey :: ToJSONKeyFunction UTCTime

toJSONKeyList :: ToJSONKeyFunction [UTCTime]

ToByteString UTCTime

Defined in Amazonka.Data.ByteString

Methods

toBS :: UTCTime -> ByteString

ToLog UTCTime

Defined in Amazonka.Data.Log

Methods

build :: UTCTime -> ByteStringBuilder

Data UTCTime

Defined in Data.Time.Clock.Internal.UTCTime

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> UTCTime -> c UTCTime

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c UTCTime

toConstr :: UTCTime -> Constr

dataTypeOf :: UTCTime -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c UTCTime)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c UTCTime)

gmapT :: (forall b. Data b => b -> b) -> UTCTime -> UTCTime

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> UTCTime -> r

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> UTCTime -> r

gmapQ :: (forall d. Data d => d -> u) -> UTCTime -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> UTCTime -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> UTCTime -> m UTCTime

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> UTCTime -> m UTCTime

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> UTCTime -> m UTCTime

NFData UTCTime

Defined in Data.Time.Clock.Internal.UTCTime

Methods

rnf :: UTCTime -> ()

Eq UTCTime

Defined in Data.Time.Clock.Internal.UTCTime

Methods

(==) :: UTCTime -> UTCTime -> Bool

(/=) :: UTCTime -> UTCTime -> Bool

Ord UTCTime

Defined in Data.Time.Clock.Internal.UTCTime

Methods

compare :: UTCTime -> UTCTime -> Ordering

(<) :: UTCTime -> UTCTime -> Bool

(<=) :: UTCTime -> UTCTime -> Bool

(>) :: UTCTime -> UTCTime -> Bool

(>=) :: UTCTime -> UTCTime -> Bool

max :: UTCTime -> UTCTime -> UTCTime

min :: UTCTime -> UTCTime -> UTCTime

may :: Applicative f => ([a] -> f b) -> [a] -> f (Maybe b)

(.!@) :: Functor f => f (Maybe a) -> a -> f a infixl 7

nonEmptyText :: Fold a Text -> Fold a Bool

matchError :: ErrorCode -> Accept -> Acceptor a

matchStatus :: Int -> Accept -> Acceptor a

matchNonEmpty :: Bool -> Accept -> Fold (AWSResponse a) b -> Acceptor a

matchAny :: Eq b => b -> Accept -> Fold (AWSResponse a) b -> Acceptor a

matchAll :: Eq b => b -> Accept -> Fold (AWSResponse a) b -> Acceptor a

accept :: Wait a -> Acceptor a

wait_acceptors :: Lens (Wait a) (Wait b) [Acceptor a] [Acceptor b]

wait_delay :: Lens' (Wait a) Seconds

wait_attempts :: Lens' (Wait a) Int

wait_name :: Lens' (Wait a) ByteString

type Acceptor a = Request a -> Either Error (ClientResponse (AWSResponse a)) -> Maybe Accept

data Accept

Constructors

AcceptSuccess

AcceptFailure

AcceptRetry

Instances

ToLog Accept

Defined in Amazonka.Waiter

Methods

build :: Accept -> ByteStringBuilder

Show Accept

Defined in Amazonka.Waiter

Methods

showsPrec :: Int -> Accept -> ShowS

show :: Accept -> String

showList :: [Accept] -> ShowS

Eq Accept

Defined in Amazonka.Waiter

Methods

(==) :: Accept -> Accept -> Bool

(/=) :: Accept -> Accept -> Bool

data Wait a

Timing and acceptance criteria to check fulfillment of a remote operation.

Constructors

Wait

Fields

• name :: ByteString
• attempts :: Int
• delay :: Seconds
• acceptors :: [Acceptor a]

defaultEndpoint :: Service -> Region -> Endpoint

Determine the full host address and credential scope within the specified Region.

setEndpoint

Arguments

:: Bool

Whether to use HTTPS (ie. SSL).

-> ByteString

The hostname to connect to.

-> Int

The port number to connect to.

-> Service

The service configuration to override.

-> Service

A convenience function for overriding the Service Endpoint.

See: $sel:endpoint:Service.

decodeError :: Abbrev -> Status -> [Header] -> ByteStringLazy -> Either String ServiceError -> Error

parseRESTError :: Abbrev -> Status -> [Header] -> a -> Error

parseXMLError :: Abbrev -> Status -> [Header] -> ByteStringLazy -> Error

parseJSONError :: Abbrev -> Status -> [Header] -> ByteStringLazy -> Error

getErrorCode :: Status -> [Header] -> ErrorCode

getRequestId :: [Header] -> Maybe RequestId

serviceError :: Abbrev -> Status -> [Header] -> Maybe ErrorCode -> Maybe ErrorMessage -> Maybe RequestId -> ServiceError

hasCode :: (Applicative f, Choice p) => ErrorCode -> Optic' p f ServiceError ServiceError

hasStatus :: (Applicative f, Choice p) => Int -> Optic' p f ServiceError ServiceError

hasService :: (Applicative f, Choice p) => Service -> Optic' p f ServiceError ServiceError

_HttpStatus :: AsError a => Traversal' a Status

statusSuccess :: Status -> Bool

_MatchServiceError :: AsError a => Service -> ErrorCode -> Fold a ServiceError

Provides a generalised prism for catching a specific service error identified by the opaque service abbreviation and error code.

This can be used if the generated error prisms provided by Amazonka.ServiceName.Types do not cover all the thrown error codes. For example to define a new error prism:

{-# LANGUAGE OverloadedStrings #-}

import Amazonka.S3 (ServiceError, s3)

_NoSuchBucketPolicy :: AsError a => Fold a ServiceError
_NoSuchBucketPolicy = _MatchServiceError s3 "NoSuchBucketPolicy"

With example usage being:

>>> import Control.Exception.Lens (trying)
>>> :t trying _NoSuchBucketPolicy
MonadCatch m => m a -> m (Either ServiceError a)

choice :: (Alternative f, ToText a, ToText b) => (s -> f a) -> (s -> f b) -> Getter s (f Text)

stop :: AWSTruncated a => a -> Bool

class AWSRequest a => AWSPager a where

Specify how an AWSRequest and it's associated Rs response can generate a subsequent request, if available.

Methods

page :: a -> AWSResponse a -> Maybe a

class AWSTruncated a where

Generalise IsTruncated and other optional/required response pagination fields.

Methods

truncated :: a -> Bool

Instances

AWSTruncated Bool

Defined in Amazonka.Pager

Methods

truncated :: Bool -> Bool

AWSTruncated (Maybe Bool)

Defined in Amazonka.Pager

Methods

truncated :: Maybe Bool -> Bool

AWSTruncated (Maybe a)

Defined in Amazonka.Pager

Methods

truncated :: Maybe a -> Bool

AWSTruncated [a]

Defined in Amazonka.Pager

Methods

truncated :: [a] -> Bool

AWSTruncated (HashMap k v)

Defined in Amazonka.Pager

Methods

truncated :: HashMap k v -> Bool

toMicroseconds :: Seconds -> Int

toSeconds :: Seconds -> DiffTime

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

authEnv_expiration :: Lens' AuthEnv (Maybe ISO8601)

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

authEnv_secretAccessKey :: Lens' AuthEnv (Sensitive SecretKey)

authEnv_accessKeyId :: Lens' AuthEnv AccessKey

_SessionToken :: Iso' SessionToken ByteString

_SecretKey :: Iso' SecretKey ByteString

_AccessKey :: Iso' AccessKey ByteString

requestUnsigned :: Request a -> Region -> ClientRequest

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

requestPresign :: Seconds -> Algorithm a

requestSign :: Algorithm a

request_body :: Lens' (Request a) RequestBody

request_headers :: Lens' (Request a) [Header]

request_query :: Lens' (Request a) QueryString

request_path :: Lens' (Request a) RawPath

request_method :: Lens' (Request a) StdMethod

request_service :: Lens' (Request a) Service

service_retry :: Lens' Service Retry

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

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

service_timeout :: Lens' Service (Maybe Seconds)

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

service_endpointPrefix :: Lens' Service ByteString

service_s3AddressingStyle :: Lens' Service S3AddressingStyle

service_version :: Lens' Service ByteString

service_signingName :: Lens' Service ByteString

service_signer :: Lens' Service Signer

service_abbrev :: Lens' Service Abbrev

signed_signedRequest :: Lens' (Signed a) ClientRequest

signed_signedMeta :: Lens' (Signed a) Meta

retry_check :: Lens' Retry (ServiceError -> Maybe Text)

retry_attempts :: Lens' Retry Int

retry_growth :: Lens' Retry Int

retry_base :: Lens' Retry Double

endpoint_scope :: Lens' Endpoint ByteString

endpoint_port :: Lens' Endpoint Int

endpoint_secure :: Lens' Endpoint Bool

endpoint_basePath :: Lens' Endpoint RawPath

endpoint_host :: Lens' Endpoint ByteString

serviceError_requestId :: Lens' ServiceError (Maybe RequestId)

serviceError_message :: Lens' ServiceError (Maybe ErrorMessage)

serviceError_code :: Lens' ServiceError ErrorCode

serviceError_headers :: Lens' ServiceError [Header]

serviceError_status :: Lens' ServiceError Status

serviceError_abbrev :: Lens' ServiceError Abbrev

serializeError_message :: Lens' SerializeError String

serializeError_body :: Lens' SerializeError (Maybe ByteStringLazy)

serializeError_status :: Lens' SerializeError Status

serializeError_abbrev :: Lens' SerializeError Abbrev

_RequestId :: Iso' RequestId Text

_ErrorMessage :: Iso' ErrorMessage Text

newErrorCode :: Text -> ErrorCode

Construct an ErrorCode.

_ErrorCode :: Iso' ErrorCode Text

_Abbrev :: Iso' Abbrev Text

newClientRequest :: Endpoint -> Maybe Seconds -> ClientRequest

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

type ClientRequest = Request

A convenience alias to avoid type ambiguity.

type ClientResponse = Response

A convenience alias encapsulating the common Response.

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

A convenience alias encapsulating the common Response body.

data Abbrev

Abbreviated service name.

Instances

FromJSON Abbrev

Defined in Amazonka.Types

Methods

parseJSON :: Value -> Parser Abbrev

parseJSONList :: Value -> Parser [Abbrev]

ToLog Abbrev

Defined in Amazonka.Types

Methods

build :: Abbrev -> ByteStringBuilder

FromText Abbrev

Defined in Amazonka.Types

Methods

fromText :: Text -> Either String Abbrev

ToText Abbrev

Defined in Amazonka.Types

Methods

toText :: Abbrev -> Text

FromXML Abbrev

Defined in Amazonka.Types

Methods

parseXML :: [Node] -> Either String Abbrev

IsString Abbrev

Defined in Amazonka.Types

Methods

fromString :: String -> Abbrev

Generic Abbrev

Defined in Amazonka.Types

Associated Types

type Rep Abbrev :: Type -> Type

Methods

from :: Abbrev -> Rep Abbrev x

to :: Rep Abbrev x -> Abbrev

Show Abbrev

Defined in Amazonka.Types

Methods

showsPrec :: Int -> Abbrev -> ShowS

show :: Abbrev -> String

showList :: [Abbrev] -> ShowS

Eq Abbrev

Defined in Amazonka.Types

Methods

(==) :: Abbrev -> Abbrev -> Bool

(/=) :: Abbrev -> Abbrev -> Bool

Ord Abbrev

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

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)))

newtype ErrorCode

Constructors

ErrorCode Text

Instances

FromJSON ErrorCode

Defined in Amazonka.Types

Methods

parseJSON :: Value -> Parser ErrorCode

parseJSONList :: Value -> Parser [ErrorCode]

ToLog ErrorCode

Defined in Amazonka.Types

Methods

build :: ErrorCode -> ByteStringBuilder

FromText ErrorCode

Defined in Amazonka.Types

Methods

fromText :: Text -> Either String ErrorCode

ToText ErrorCode

Defined in Amazonka.Types

Methods

toText :: ErrorCode -> Text

FromXML ErrorCode

Defined in Amazonka.Types

Methods

parseXML :: [Node] -> Either String ErrorCode

IsString ErrorCode

Defined in Amazonka.Types

Methods

fromString :: String -> ErrorCode

Show ErrorCode

Defined in Amazonka.Types

Methods

showsPrec :: Int -> ErrorCode -> ShowS

show :: ErrorCode -> String

showList :: [ErrorCode] -> ShowS

Eq ErrorCode

Defined in Amazonka.Types

Methods

(==) :: ErrorCode -> ErrorCode -> Bool

(/=) :: ErrorCode -> ErrorCode -> Bool

Ord ErrorCode

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

newtype ErrorMessage

Constructors

ErrorMessage

Fields

• fromErrorMessage :: Text

Instances

FromJSON ErrorMessage

Defined in Amazonka.Types

Methods

parseJSON :: Value -> Parser ErrorMessage

parseJSONList :: Value -> Parser [ErrorMessage]

ToLog ErrorMessage

Defined in Amazonka.Types

Methods

build :: ErrorMessage -> ByteStringBuilder

FromText ErrorMessage

Defined in Amazonka.Types

Methods

fromText :: Text -> Either String ErrorMessage

ToText ErrorMessage

Defined in Amazonka.Types

Methods

toText :: ErrorMessage -> Text

FromXML ErrorMessage

Defined in Amazonka.Types

Methods

parseXML :: [Node] -> Either String ErrorMessage

IsString ErrorMessage

Defined in Amazonka.Types

Methods

fromString :: String -> ErrorMessage

Generic ErrorMessage

Defined in Amazonka.Types

Associated Types

type Rep ErrorMessage :: Type -> Type

Methods

from :: ErrorMessage -> Rep ErrorMessage x

to :: Rep ErrorMessage x -> ErrorMessage

Show ErrorMessage

Defined in Amazonka.Types

Methods

showsPrec :: Int -> ErrorMessage -> ShowS

show :: ErrorMessage -> String

showList :: [ErrorMessage] -> ShowS

Eq ErrorMessage

Defined in Amazonka.Types

Methods

(==) :: ErrorMessage -> ErrorMessage -> Bool

(/=) :: ErrorMessage -> ErrorMessage -> Bool

Ord ErrorMessage

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

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

Constructors

RequestId

Fields

• fromRequestId :: Text

Instances

FromJSON RequestId

Defined in Amazonka.Types

Methods

parseJSON :: Value -> Parser RequestId

parseJSONList :: Value -> Parser [RequestId]

ToLog RequestId

Defined in Amazonka.Types

Methods

build :: RequestId -> ByteStringBuilder

FromText RequestId

Defined in Amazonka.Types

Methods

fromText :: Text -> Either String RequestId

ToText RequestId

Defined in Amazonka.Types

Methods

toText :: RequestId -> Text

FromXML RequestId

Defined in Amazonka.Types

Methods

parseXML :: [Node] -> Either String RequestId

IsString RequestId

Defined in Amazonka.Types

Methods

fromString :: String -> RequestId

Generic RequestId

Defined in Amazonka.Types

Associated Types

type Rep RequestId :: Type -> Type

Methods

from :: RequestId -> Rep RequestId x

to :: Rep RequestId x -> RequestId

Show RequestId

Defined in Amazonka.Types

Methods

showsPrec :: Int -> RequestId -> ShowS

show :: RequestId -> String

showList :: [RequestId] -> ShowS

Eq RequestId

Defined in Amazonka.Types

Methods

(==) :: RequestId -> RequestId -> Bool

(/=) :: RequestId -> RequestId -> Bool

Ord RequestId

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

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)))

data Error

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

Constructors

TransportError HttpException

SerializeError SerializeError

ServiceError ServiceError

Instances

ToLog Error

Defined in Amazonka.Types

Methods

build :: Error -> ByteStringBuilder

AsError Error

Defined in Amazonka.Types

Methods

_Error :: Prism' Error Error

_TransportError :: Prism' Error HttpException

_SerializeError :: Prism' Error SerializeError

_ServiceError :: Prism' Error ServiceError

Exception Error

Defined in Amazonka.Types

Methods

toException :: Error -> SomeException

fromException :: SomeException -> Maybe Error

displayException :: Error -> String

Generic Error

Defined in Amazonka.Types

Associated Types

type Rep Error :: Type -> Type

Methods

from :: Error -> Rep Error x

to :: Rep Error x -> Error

Show Error

Defined in Amazonka.Types

Methods

showsPrec :: Int -> Error -> ShowS

show :: Error -> String

showList :: [Error] -> ShowS

type Rep Error

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))))

data SerializeError

Constructors

SerializeError'

Fields

• abbrev :: Abbrev
• status :: Status
• body :: Maybe ByteStringLazy

  The response body, if the response was not streaming.

• message :: String

Instances

ToLog SerializeError

Defined in Amazonka.Types

Methods

build :: SerializeError -> ByteStringBuilder

Generic SerializeError

Defined in Amazonka.Types

Associated Types

type Rep SerializeError :: Type -> Type

Methods

from :: SerializeError -> Rep SerializeError x

to :: Rep SerializeError x -> SerializeError

Show SerializeError

Defined in Amazonka.Types

Methods

showsPrec :: Int -> SerializeError -> ShowS

show :: SerializeError -> String

showList :: [SerializeError] -> ShowS

Eq SerializeError

Defined in Amazonka.Types

Methods

(==) :: SerializeError -> SerializeError -> Bool

(/=) :: SerializeError -> SerializeError -> Bool

type Rep SerializeError

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))))

data ServiceError

Constructors

ServiceError'

Fields

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

Instances

ToLog ServiceError

Defined in Amazonka.Types

Methods

build :: ServiceError -> ByteStringBuilder

Generic ServiceError

Defined in Amazonka.Types

Associated Types

type Rep ServiceError :: Type -> Type

Methods

from :: ServiceError -> Rep ServiceError x

to :: Rep ServiceError x -> ServiceError

Show ServiceError

Defined in Amazonka.Types

Methods

showsPrec :: Int -> ServiceError -> ShowS

show :: ServiceError -> String

showList :: [ServiceError] -> ShowS

Eq ServiceError

Defined in Amazonka.Types

Methods

(==) :: ServiceError -> ServiceError -> Bool

(/=) :: ServiceError -> ServiceError -> Bool

type Rep ServiceError

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))))))

class AsError a where

Minimal complete definition

_Error

Methods

_Error :: Prism' a Error

A general Amazonka error.

_TransportError :: Prism' a HttpException

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

_SerializeError :: Prism' a SerializeError

A serialisation error occured when attempting to deserialise a response.

_ServiceError :: Prism' a ServiceError

A service specific error returned by the remote service.

Instances

AsError Error

Defined in Amazonka.Types

Methods

_Error :: Prism' Error Error

_TransportError :: Prism' Error HttpException

_SerializeError :: Prism' Error SerializeError

_ServiceError :: Prism' Error ServiceError

AsError SomeException

Defined in Amazonka.Types

Methods

_Error :: Prism' SomeException Error

_TransportError :: Prism' SomeException HttpException

_SerializeError :: Prism' SomeException SerializeError

_ServiceError :: Prism' SomeException ServiceError

data Endpoint

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

Generic Endpoint

Defined in Amazonka.Types

Associated Types

type Rep Endpoint :: Type -> Type

Methods

from :: Endpoint -> Rep Endpoint x

to :: Rep Endpoint x -> Endpoint

Show Endpoint

Defined in Amazonka.Types

Methods

showsPrec :: Int -> Endpoint -> ShowS

show :: Endpoint -> String

showList :: [Endpoint] -> ShowS

Eq Endpoint

Defined in Amazonka.Types

Methods

(==) :: Endpoint -> Endpoint -> Bool

(/=) :: Endpoint -> Endpoint -> Bool

type Rep Endpoint

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)))))

data Retry

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

Generic Retry

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

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)))))

data Meta where

Signing algorithm specific metadata.

Constructors

Meta :: forall a. ToLog a => a -> Meta

Instances

ToLog Meta

Defined in Amazonka.Types

Methods

build :: Meta -> ByteStringBuilder

data Signed a

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

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

data Signer

Constructors

Signer (forall a. Algorithm a) (forall a. Seconds -> Algorithm a)

data Service

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

Generic Service

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

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

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

Generic S3AddressingStyle

Defined in Amazonka.Types

Associated Types

type Rep S3AddressingStyle :: Type -> Type

Methods

from :: S3AddressingStyle -> Rep S3AddressingStyle x

to :: Rep S3AddressingStyle x -> S3AddressingStyle

Show S3AddressingStyle

Defined in Amazonka.Types

Methods

showsPrec :: Int -> S3AddressingStyle -> ShowS

show :: S3AddressingStyle -> String

showList :: [S3AddressingStyle] -> ShowS

Eq S3AddressingStyle

Defined in Amazonka.Types

Methods

(==) :: S3AddressingStyle -> S3AddressingStyle -> Bool

(/=) :: S3AddressingStyle -> S3AddressingStyle -> Bool

type Rep S3AddressingStyle

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)))

data Request a

An unsigned request.

Constructors

Request

Fields

• service :: Service
• method :: StdMethod
• path :: RawPath
• query :: QueryString
• headers :: [Header]
• body :: RequestBody

Instances

Generic (Request a)

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)

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)))))

type family AWSResponse a

The successful, expected response associated with a request.

Instances

type AWSResponse GetRoleCredentials

Defined in Amazonka.SSO.GetRoleCredentials

type AWSResponse GetRoleCredentials = GetRoleCredentialsResponse

type AWSResponse AssumeRole

Defined in Amazonka.STS.AssumeRole

type AWSResponse AssumeRole = AssumeRoleResponse

type AWSResponse AssumeRoleWithSAML

Defined in Amazonka.STS.AssumeRoleWithSAML

type AWSResponse AssumeRoleWithSAML = AssumeRoleWithSAMLResponse

type AWSResponse AssumeRoleWithWebIdentity

Defined in Amazonka.STS.AssumeRoleWithWebIdentity

type AWSResponse AssumeRoleWithWebIdentity = AssumeRoleWithWebIdentityResponse

type AWSResponse DecodeAuthorizationMessage

Defined in Amazonka.STS.DecodeAuthorizationMessage

type AWSResponse DecodeAuthorizationMessage = DecodeAuthorizationMessageResponse

type AWSResponse GetAccessKeyInfo

Defined in Amazonka.STS.GetAccessKeyInfo

type AWSResponse GetAccessKeyInfo = GetAccessKeyInfoResponse

type AWSResponse GetCallerIdentity

Defined in Amazonka.STS.GetCallerIdentity

type AWSResponse GetCallerIdentity = GetCallerIdentityResponse

type AWSResponse GetFederationToken

Defined in Amazonka.STS.GetFederationToken

type AWSResponse GetFederationToken = GetFederationTokenResponse

type AWSResponse GetSessionToken

Defined in Amazonka.STS.GetSessionToken

type AWSResponse GetSessionToken = GetSessionTokenResponse

class AWSRequest a where

Specify how a request can be de/serialised.

Associated Types

type AWSResponse a

The successful, expected response associated with a request.

Methods

request

Arguments

:: (Service -> Service)

Overrides applied to the default Service.

-> a

-> Request a

response

Arguments

:: MonadResource m

=> (ByteStringLazy -> IO ByteStringLazy)

Raw response body hook.

-> Service

-> Proxy a

-> ClientResponse ClientBody

-> m (Either Error (ClientResponse (AWSResponse a)))

Instances

AWSRequest GetRoleCredentials

Defined in Amazonka.SSO.GetRoleCredentials

Associated Types

type AWSResponse GetRoleCredentials

Methods

request :: (Service -> Service) -> GetRoleCredentials -> Request GetRoleCredentials

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetRoleCredentials -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetRoleCredentials)))

AWSRequest AssumeRole

Defined in Amazonka.STS.AssumeRole

Associated Types

type AWSResponse AssumeRole

Methods

request :: (Service -> Service) -> AssumeRole -> Request AssumeRole

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy AssumeRole -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse AssumeRole)))

AWSRequest AssumeRoleWithSAML

Defined in Amazonka.STS.AssumeRoleWithSAML

Associated Types

type AWSResponse AssumeRoleWithSAML

Methods

request :: (Service -> Service) -> AssumeRoleWithSAML -> Request AssumeRoleWithSAML

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy AssumeRoleWithSAML -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse AssumeRoleWithSAML)))

AWSRequest AssumeRoleWithWebIdentity

Defined in Amazonka.STS.AssumeRoleWithWebIdentity

Associated Types

type AWSResponse AssumeRoleWithWebIdentity

Methods

request :: (Service -> Service) -> AssumeRoleWithWebIdentity -> Request AssumeRoleWithWebIdentity

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy AssumeRoleWithWebIdentity -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse AssumeRoleWithWebIdentity)))

AWSRequest DecodeAuthorizationMessage

Defined in Amazonka.STS.DecodeAuthorizationMessage

Associated Types

type AWSResponse DecodeAuthorizationMessage

Methods

request :: (Service -> Service) -> DecodeAuthorizationMessage -> Request DecodeAuthorizationMessage

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DecodeAuthorizationMessage -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DecodeAuthorizationMessage)))

AWSRequest GetAccessKeyInfo

Defined in Amazonka.STS.GetAccessKeyInfo

Associated Types

type AWSResponse GetAccessKeyInfo

Methods

request :: (Service -> Service) -> GetAccessKeyInfo -> Request GetAccessKeyInfo

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetAccessKeyInfo -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetAccessKeyInfo)))

AWSRequest GetCallerIdentity

Defined in Amazonka.STS.GetCallerIdentity

Associated Types

type AWSResponse GetCallerIdentity

Methods

request :: (Service -> Service) -> GetCallerIdentity -> Request GetCallerIdentity

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetCallerIdentity -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetCallerIdentity)))

AWSRequest GetFederationToken

Defined in Amazonka.STS.GetFederationToken

Associated Types

type AWSResponse GetFederationToken

Methods

request :: (Service -> Service) -> GetFederationToken -> Request GetFederationToken

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetFederationToken -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetFederationToken)))

AWSRequest GetSessionToken

Defined in Amazonka.STS.GetSessionToken

Associated Types

type AWSResponse GetSessionToken

Methods

request :: (Service -> Service) -> GetSessionToken -> Request GetSessionToken

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetSessionToken -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetSessionToken)))

newtype AccessKey

An access key ID.

For example: AKIAIOSFODNN7EXAMPLE

See: Understanding and Getting Your Security Credentials.

Constructors

AccessKey ByteString

Instances

FromJSON AccessKey

Defined in Amazonka.Types

Methods

parseJSON :: Value -> Parser AccessKey

parseJSONList :: Value -> Parser [AccessKey]

ToJSON AccessKey

Defined in Amazonka.Types

Methods

toJSON :: AccessKey -> Value

toEncoding :: AccessKey -> Encoding

toJSONList :: [AccessKey] -> Value

toEncodingList :: [AccessKey] -> Encoding

ToByteString AccessKey

Defined in Amazonka.Types

Methods

toBS :: AccessKey -> ByteString

ToLog AccessKey

Defined in Amazonka.Types

Methods

build :: AccessKey -> ByteStringBuilder

ToQuery AccessKey

Defined in Amazonka.Types

Methods

toQuery :: AccessKey -> QueryString

FromText AccessKey

Defined in Amazonka.Types

Methods

fromText :: Text -> Either String AccessKey

ToText AccessKey

Defined in Amazonka.Types

Methods

toText :: AccessKey -> Text

FromXML AccessKey

Defined in Amazonka.Types

Methods

parseXML :: [Node] -> Either String AccessKey

ToXML AccessKey

Defined in Amazonka.Types

Methods

toXML :: AccessKey -> XML

IsString AccessKey

Defined in Amazonka.Types

Methods

fromString :: String -> AccessKey

Generic AccessKey

Defined in Amazonka.Types

Associated Types

type Rep AccessKey :: Type -> Type

Methods

from :: AccessKey -> Rep AccessKey x

to :: Rep AccessKey x -> AccessKey

Read AccessKey

Defined in Amazonka.Types

Methods

readsPrec :: Int -> ReadS AccessKey

readList :: ReadS [AccessKey]

readPrec :: ReadPrec AccessKey

readListPrec :: ReadPrec [AccessKey]

Show AccessKey

Defined in Amazonka.Types

Methods

showsPrec :: Int -> AccessKey -> ShowS

show :: AccessKey -> String

showList :: [AccessKey] -> ShowS

NFData AccessKey

Defined in Amazonka.Types

Methods

rnf :: AccessKey -> ()

Eq AccessKey

Defined in Amazonka.Types

Methods

(==) :: AccessKey -> AccessKey -> Bool

(/=) :: AccessKey -> AccessKey -> Bool

Hashable AccessKey

Defined in Amazonka.Types

Methods

hashWithSalt :: Int -> AccessKey -> Int

hash :: AccessKey -> Int

type Rep AccessKey

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

Secret access key credential.

For example: wJalrXUtnFEMIK7MDENGbPxRfiCYEXAMPLEKE

See: Understanding and Getting Your Security Credentials.

Constructors

SecretKey ByteString

Instances

FromJSON SecretKey

Defined in Amazonka.Types

Methods

parseJSON :: Value -> Parser SecretKey

parseJSONList :: Value -> Parser [SecretKey]

ToJSON SecretKey

Defined in Amazonka.Types

Methods

toJSON :: SecretKey -> Value

toEncoding :: SecretKey -> Encoding

toJSONList :: [SecretKey] -> Value

toEncodingList :: [SecretKey] -> Encoding

ToByteString SecretKey

Defined in Amazonka.Types

Methods

toBS :: SecretKey -> ByteString

FromText SecretKey

Defined in Amazonka.Types

Methods

fromText :: Text -> Either String SecretKey

ToText SecretKey

Defined in Amazonka.Types

Methods

toText :: SecretKey -> Text

FromXML SecretKey

Defined in Amazonka.Types

Methods

parseXML :: [Node] -> Either String SecretKey

ToXML SecretKey

Defined in Amazonka.Types

Methods

toXML :: SecretKey -> XML

IsString SecretKey

Defined in Amazonka.Types

Methods

fromString :: String -> SecretKey

Generic SecretKey

Defined in Amazonka.Types

Associated Types

type Rep SecretKey :: Type -> Type

Methods

from :: SecretKey -> Rep SecretKey x

to :: Rep SecretKey x -> SecretKey

NFData SecretKey

Defined in Amazonka.Types

Methods

rnf :: SecretKey -> ()

Eq SecretKey

Defined in Amazonka.Types

Methods

(==) :: SecretKey -> SecretKey -> Bool

(/=) :: SecretKey -> SecretKey -> Bool

Hashable SecretKey

Defined in Amazonka.Types

Methods

hashWithSalt :: Int -> SecretKey -> Int

hash :: SecretKey -> Int

type Rep SecretKey

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

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

See: Temporary Security Credentials.

Constructors

SessionToken ByteString

Instances

FromJSON SessionToken

Defined in Amazonka.Types

Methods

parseJSON :: Value -> Parser SessionToken

parseJSONList :: Value -> Parser [SessionToken]

ToJSON SessionToken

Defined in Amazonka.Types

Methods

toJSON :: SessionToken -> Value

toEncoding :: SessionToken -> Encoding

toJSONList :: [SessionToken] -> Value

toEncodingList :: [SessionToken] -> Encoding

ToByteString SessionToken

Defined in Amazonka.Types

Methods

toBS :: SessionToken -> ByteString

FromText SessionToken

Defined in Amazonka.Types

Methods

fromText :: Text -> Either String SessionToken

ToText SessionToken

Defined in Amazonka.Types

Methods

toText :: SessionToken -> Text

FromXML SessionToken

Defined in Amazonka.Types

Methods

parseXML :: [Node] -> Either String SessionToken

ToXML SessionToken

Defined in Amazonka.Types

Methods

toXML :: SessionToken -> XML

IsString SessionToken

Defined in Amazonka.Types

Methods

fromString :: String -> SessionToken

Generic SessionToken

Defined in Amazonka.Types

Associated Types

type Rep SessionToken :: Type -> Type

Methods

from :: SessionToken -> Rep SessionToken x

to :: Rep SessionToken x -> SessionToken

NFData SessionToken

Defined in Amazonka.Types

Methods

rnf :: SessionToken -> ()

Eq SessionToken

Defined in Amazonka.Types

Methods

(==) :: SessionToken -> SessionToken -> Bool

(/=) :: SessionToken -> SessionToken -> Bool

Hashable SessionToken

Defined in Amazonka.Types

Methods

hashWithSalt :: Int -> SessionToken -> Int

hash :: SessionToken -> Int

type Rep SessionToken

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)))

data AuthEnv

The AuthN/AuthZ credential environment.

Constructors

AuthEnv

Fields

• accessKeyId :: AccessKey
• secretAccessKey :: Sensitive SecretKey
• sessionToken :: Maybe (Sensitive SessionToken)
• expiration :: Maybe ISO8601

Instances

FromJSON AuthEnv

Defined in Amazonka.Types

Methods

parseJSON :: Value -> Parser AuthEnv

parseJSONList :: Value -> Parser [AuthEnv]

ToLog AuthEnv

Defined in Amazonka.Types

Methods

build :: AuthEnv -> ByteStringBuilder

FromXML AuthEnv

Defined in Amazonka.Types

Methods

parseXML :: [Node] -> Either String AuthEnv

Generic AuthEnv

Defined in Amazonka.Types

Associated Types

type Rep AuthEnv :: Type -> Type

Methods

from :: AuthEnv -> Rep AuthEnv x

to :: Rep AuthEnv x -> AuthEnv

Show AuthEnv

Defined in Amazonka.Types

Methods

showsPrec :: Int -> AuthEnv -> ShowS

show :: AuthEnv -> String

showList :: [AuthEnv] -> ShowS

NFData AuthEnv

Defined in Amazonka.Types

Methods

rnf :: AuthEnv -> ()

Eq AuthEnv

Defined in Amazonka.Types

Methods

(==) :: AuthEnv -> AuthEnv -> Bool

(/=) :: AuthEnv -> AuthEnv -> Bool

type Rep AuthEnv

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)))))

data Auth

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

ToLog Auth

Defined in Amazonka.Types

Methods

build :: Auth -> ByteStringBuilder

newtype Region

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

FromJSON Region

Defined in Amazonka.Types

Methods

parseJSON :: Value -> Parser Region

parseJSONList :: Value -> Parser [Region]

ToJSON Region

Defined in Amazonka.Types

Methods

toJSON :: Region -> Value

toEncoding :: Region -> Encoding

toJSONList :: [Region] -> Value

toEncodingList :: [Region] -> Encoding

ToByteString Region

Defined in Amazonka.Types

Methods

toBS :: Region -> ByteString

ToLog Region

Defined in Amazonka.Types

Methods

build :: Region -> ByteStringBuilder

ToQuery Region

Defined in Amazonka.Types

Methods

toQuery :: Region -> QueryString

FromText Region

Defined in Amazonka.Types

Methods

fromText :: Text -> Either String Region

ToText Region

Defined in Amazonka.Types

Methods

toText :: Region -> Text

FromXML Region

Defined in Amazonka.Types

Methods

parseXML :: [Node] -> Either String Region

ToXML Region

Defined in Amazonka.Types

Methods

toXML :: Region -> XML

IsString Region

Defined in Amazonka.Types

Methods

fromString :: String -> Region

Generic Region

Defined in Amazonka.Types

Associated Types

type Rep Region :: Type -> Type

Methods

from :: Region -> Rep Region x

to :: Rep Region x -> Region

Read Region

Defined in Amazonka.Types

Methods

readsPrec :: Int -> ReadS Region

readList :: ReadS [Region]

readPrec :: ReadPrec Region

readListPrec :: ReadPrec [Region]

Show Region

Defined in Amazonka.Types

Methods

showsPrec :: Int -> Region -> ShowS

show :: Region -> String

showList :: [Region] -> ShowS

NFData Region

Defined in Amazonka.Types

Methods

rnf :: Region -> ()

Eq Region

Defined in Amazonka.Types

Methods

(==) :: Region -> Region -> Bool

(/=) :: Region -> Region -> Bool

Ord Region

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

Defined in Amazonka.Types

Methods

hashWithSalt :: Int -> Region -> Int

hash :: Region -> Int

type Rep Region

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)))

newtype Seconds

A numeric value representing seconds.

Constructors

Seconds DiffTime

Instances

ToByteString Seconds

Defined in Amazonka.Types

Methods

toBS :: Seconds -> ByteString

ToLog Seconds

Defined in Amazonka.Types

Methods

build :: Seconds -> ByteStringBuilder

ToQuery Seconds

Defined in Amazonka.Types

Methods

toQuery :: Seconds -> QueryString

FromText Seconds

Defined in Amazonka.Types

Methods

fromText :: Text -> Either String Seconds

ToText Seconds

Defined in Amazonka.Types

Methods

toText :: Seconds -> Text

Enum Seconds

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

Defined in Amazonka.Types

Associated Types

type Rep Seconds :: Type -> Type

Methods

from :: Seconds -> Rep Seconds x

to :: Rep Seconds x -> Seconds

Num Seconds

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

Defined in Amazonka.Types

Methods

readsPrec :: Int -> ReadS Seconds

readList :: ReadS [Seconds]

readPrec :: ReadPrec Seconds

readListPrec :: ReadPrec [Seconds]

Real Seconds

Defined in Amazonka.Types

Methods

toRational :: Seconds -> Rational

Show Seconds

Defined in Amazonka.Types

Methods

showsPrec :: Int -> Seconds -> ShowS

show :: Seconds -> String

showList :: [Seconds] -> ShowS

NFData Seconds

Defined in Amazonka.Types

Methods

rnf :: Seconds -> ()

Eq Seconds

Defined in Amazonka.Types

Methods

(==) :: Seconds -> Seconds -> Bool

(/=) :: Seconds -> Seconds -> Bool

Ord Seconds

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

Defined in Amazonka.Types

Methods

hashWithSalt :: Int -> Seconds -> Int

hash :: Seconds -> Int

type Rep Seconds

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)))

_Base64 :: Iso' Base64 ByteString

newtype Base64

Base64 encoded binary data.

Encoding/decoding is automatically deferred to serialisation and deserialisation respectively.

Constructors

Base64

Fields

• unBase64 :: ByteString

Instances

FromJSON Base64

Defined in Amazonka.Data.Base64

Methods

parseJSON :: Value -> Parser Base64

parseJSONList :: Value -> Parser [Base64]

ToJSON Base64

Defined in Amazonka.Data.Base64

Methods

toJSON :: Base64 -> Value

toEncoding :: Base64 -> Encoding

toJSONList :: [Base64] -> Value

toEncodingList :: [Base64] -> Encoding

ToBody Base64

Defined in Amazonka.Data.Base64

Methods

toBody :: Base64 -> RequestBody

ToHashedBody Base64

Defined in Amazonka.Data.Base64

Methods

toHashed :: Base64 -> HashedBody

ToByteString Base64

Defined in Amazonka.Data.Base64

Methods

toBS :: Base64 -> ByteString

ToQuery Base64

Defined in Amazonka.Data.Base64

Methods

toQuery :: Base64 -> QueryString

FromText Base64

Defined in Amazonka.Data.Base64

Methods

fromText :: Text -> Either String Base64

ToText Base64

Defined in Amazonka.Data.Base64

Methods

toText :: Base64 -> Text

FromXML Base64

Defined in Amazonka.Data.Base64

Methods

parseXML :: [Node] -> Either String Base64

ToXML Base64

Defined in Amazonka.Data.Base64

Methods

toXML :: Base64 -> XML

Generic Base64

Defined in Amazonka.Data.Base64

Associated Types

type Rep Base64 :: Type -> Type

Methods

from :: Base64 -> Rep Base64 x

to :: Rep Base64 x -> Base64

Read Base64

Defined in Amazonka.Data.Base64

Methods

readsPrec :: Int -> ReadS Base64

readList :: ReadS [Base64]

readPrec :: ReadPrec Base64

readListPrec :: ReadPrec [Base64]

Show Base64

Defined in Amazonka.Data.Base64

Methods

showsPrec :: Int -> Base64 -> ShowS

show :: Base64 -> String

showList :: [Base64] -> ShowS

NFData Base64

Defined in Amazonka.Data.Base64

Methods

rnf :: Base64 -> ()

Eq Base64

Defined in Amazonka.Data.Base64

Methods

(==) :: Base64 -> Base64 -> Bool

(/=) :: Base64 -> Base64 -> Bool

Ord Base64

Defined in Amazonka.Data.Base64

Methods

compare :: Base64 -> Base64 -> Ordering

(<) :: Base64 -> Base64 -> Bool

(<=) :: Base64 -> Base64 -> Bool

(>) :: Base64 -> Base64 -> Bool

(>=) :: Base64 -> Base64 -> Bool

max :: Base64 -> Base64 -> Base64

min :: Base64 -> Base64 -> Base64

Hashable Base64

Defined in Amazonka.Data.Base64

Methods

hashWithSalt :: Int -> Base64 -> Int

hash :: Base64 -> Int

type Rep Base64

Defined in Amazonka.Data.Base64

type Rep Base64 = D1 ('MetaData "Base64" "Amazonka.Data.Base64" "amazonka-core-2.0-BFuA7FRvuklLoYhn4b6A6p" 'True) (C1 ('MetaCons "Base64" 'PrefixI 'True) (S1 ('MetaSel ('Just "unBase64") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ByteString)))

_Sensitive :: Iso' (Sensitive a) a

newtype Sensitive a

Note: read . show /= isomorphic

Constructors

Sensitive

Fields

• fromSensitive :: a

Instances

Functor Sensitive

Defined in Amazonka.Data.Sensitive

Methods

fmap :: (a -> b) -> Sensitive a -> Sensitive b

(<$) :: a -> Sensitive b -> Sensitive a

FromJSON a => FromJSON (Sensitive a)

Defined in Amazonka.Data.Sensitive

Methods

parseJSON :: Value -> Parser (Sensitive a)

parseJSONList :: Value -> Parser [Sensitive a]

ToJSON a => ToJSON (Sensitive a)

Defined in Amazonka.Data.Sensitive

Methods

toJSON :: Sensitive a -> Value

toEncoding :: Sensitive a -> Encoding

toJSONList :: [Sensitive a] -> Value

toEncodingList :: [Sensitive a] -> Encoding

ToBody a => ToBody (Sensitive a)

Defined in Amazonka.Data.Sensitive

Methods

toBody :: Sensitive a -> RequestBody

ToByteString a => ToByteString (Sensitive a)

Defined in Amazonka.Data.Sensitive

Methods

toBS :: Sensitive a -> ByteString

ToHeader a => ToHeader (Sensitive a)

Defined in Amazonka.Data.Sensitive

Methods

toHeader :: HeaderName -> Sensitive a -> [Header]

ToLog (Sensitive a)

Defined in Amazonka.Data.Sensitive

Methods

build :: Sensitive a -> ByteStringBuilder

ToQuery a => ToQuery (Sensitive a)

Defined in Amazonka.Data.Sensitive

Methods

toQuery :: Sensitive a -> QueryString

FromText a => FromText (Sensitive a)

Defined in Amazonka.Data.Sensitive

Methods

fromText :: Text -> Either String (Sensitive a)

ToText a => ToText (Sensitive a)

Defined in Amazonka.Data.Sensitive

Methods

toText :: Sensitive a -> Text

FromXML a => FromXML (Sensitive a)

Defined in Amazonka.Data.Sensitive

Methods

parseXML :: [Node] -> Either String (Sensitive a)

ToXML a => ToXML (Sensitive a)

Defined in Amazonka.Data.Sensitive

Methods

toXML :: Sensitive a -> XML

IsString a => IsString (Sensitive a)

Defined in Amazonka.Data.Sensitive

Methods

fromString :: String -> Sensitive a

Monoid a => Monoid (Sensitive a)

Defined in Amazonka.Data.Sensitive

Methods

mempty :: Sensitive a

mappend :: Sensitive a -> Sensitive a -> Sensitive a

mconcat :: [Sensitive a] -> Sensitive a

Semigroup a => Semigroup (Sensitive a)

Defined in Amazonka.Data.Sensitive

Methods

(<>) :: Sensitive a -> Sensitive a -> Sensitive a

sconcat :: NonEmpty (Sensitive a) -> Sensitive a

stimes :: Integral b => b -> Sensitive a -> Sensitive a

IsList a => IsList (Sensitive a)

Defined in Amazonka.Data.Sensitive

Associated Types

type Item (Sensitive a)

Methods

fromList :: [Item (Sensitive a)] -> Sensitive a

fromListN :: Int -> [Item (Sensitive a)] -> Sensitive a

toList :: Sensitive a -> [Item (Sensitive a)]

Generic (Sensitive a)

Defined in Amazonka.Data.Sensitive

Associated Types

type Rep (Sensitive a) :: Type -> Type

Methods

from :: Sensitive a -> Rep (Sensitive a) x

to :: Rep (Sensitive a) x -> Sensitive a

Show (Sensitive a)

Defined in Amazonka.Data.Sensitive

Methods

showsPrec :: Int -> Sensitive a -> ShowS

show :: Sensitive a -> String

showList :: [Sensitive a] -> ShowS

NFData a => NFData (Sensitive a)

Defined in Amazonka.Data.Sensitive

Methods

rnf :: Sensitive a -> ()

Eq a => Eq (Sensitive a)

Defined in Amazonka.Data.Sensitive

Methods

(==) :: Sensitive a -> Sensitive a -> Bool

(/=) :: Sensitive a -> Sensitive a -> Bool

Ord a => Ord (Sensitive a)

Defined in Amazonka.Data.Sensitive

Methods

compare :: Sensitive a -> Sensitive a -> Ordering

(<) :: Sensitive a -> Sensitive a -> Bool

(<=) :: Sensitive a -> Sensitive a -> Bool

(>) :: Sensitive a -> Sensitive a -> Bool

(>=) :: Sensitive a -> Sensitive a -> Bool

max :: Sensitive a -> Sensitive a -> Sensitive a

min :: Sensitive a -> Sensitive a -> Sensitive a

Hashable a => Hashable (Sensitive a)

Defined in Amazonka.Data.Sensitive

Methods

hashWithSalt :: Int -> Sensitive a -> Int

hash :: Sensitive a -> Int

type Item (Sensitive a)

Defined in Amazonka.Data.Sensitive

type Item (Sensitive a) = Item a

type Rep (Sensitive a)

Defined in Amazonka.Data.Sensitive

type Rep (Sensitive a) = D1 ('MetaData "Sensitive" "Amazonka.Data.Sensitive" "amazonka-core-2.0-BFuA7FRvuklLoYhn4b6A6p" 'True) (C1 ('MetaCons "Sensitive" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromSensitive") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 a)))

contentLength :: RequestBody -> Integer

toRequestBody :: RequestBody -> RequestBody

isStreaming :: RequestBody -> Bool

md5Base64 :: RequestBody -> Maybe ByteString

hashedBody

Arguments

:: Digest SHA256

A SHA256 hash of the file contents.

-> Integer

The size of the stream in bytes.

-> ConduitM () ByteString (ResourceT IO) ()

-> HashedBody

Construct a HashedBody from a Source, manually specifying the SHA256 hash and file size. It's left up to the caller to calculate these correctly, otherwise AWS will return signing errors.

See: ToHashedBody.

hashedFileRange

Arguments

:: MonadIO m

=> FilePath

The file path to read.

-> Integer

The byte offset at which to start reading.

-> Integer

The maximum number of bytes to read.

-> m HashedBody

Construct a HashedBody from a FilePath, specifying the range of bytes to read. This can be useful for constructing multiple requests from a single file, say for S3 multipart uploads.

See: hashedFile, sourceFileRange.

hashedFile

Arguments

:: MonadIO m

=> FilePath

The file path to read.

-> m HashedBody

Construct a HashedBody from a FilePath, calculating the SHA256 hash and file size.

Note: While this function will perform in constant space, it will enumerate the entirety of the file contents twice. Firstly to calculate the SHA256 and lastly to stream the contents to the socket during sending.

See: ToHashedBody.

sha256Base16 :: HashedBody -> ByteString

sourceFileRangeChunks

Arguments

:: forall (m :: Type -> Type). MonadResource m

=> ChunkSize

The idealized size of chunks that will be yielded downstream.

-> FilePath

The file path to read.

-> Integer

The byte offset at which to start reading.

-> Integer

The maximum number of bytes to read.

-> ConduitM () ByteString m ()

sourceFileChunks :: forall (m :: Type -> Type). MonadResource m => ChunkSize -> FilePath -> ConduitM () ByteString m ()

unsafeChunkedBody

Arguments

:: ChunkSize

The idealized size of chunks that will be yielded downstream.

-> Integer

The size of the stream in bytes.

-> ConduitM () ByteString (ResourceT IO) ()

-> RequestBody

Unsafely construct a ChunkedBody.

This function is marked unsafe because it does nothing to enforce the chunk size. Typically for conduit IO functions, it's whatever ByteString's defaultBufferSize is, around 32 KB. If the chunk size is less than 8 KB, the request will error. 64 KB or higher chunk size is recommended for performance reasons.

Note that it will always create a chunked body even if the request is too small.

See: ToBody.

chunkedFileRange

Arguments

:: MonadIO m

=> ChunkSize

The idealized size of chunks that will be yielded downstream.

-> FilePath

The file path to read.

-> Integer

The byte offset at which to start reading.

-> Integer

The maximum number of bytes to read.

-> m RequestBody

Construct a ChunkedBody from a FilePath, specifying the range of bytes to read. This can be useful for constructing multiple requests from a single file, say for S3 multipart uploads.

See: chunkedFile.

chunkedFile :: MonadIO m => ChunkSize -> FilePath -> m RequestBody

Construct a ChunkedBody from a FilePath, where the contents will be read and signed incrementally in chunks if the target service supports it.

Will intelligently revert to HashedBody if the file is smaller than the specified ChunkSize.

See: ToBody.

remainderBytes :: ChunkedBody -> Maybe Integer

fullChunks :: ChunkedBody -> Integer

fuseChunks :: ChunkedBody -> ConduitM ByteString ByteString (ResourceT IO) () -> ChunkedBody

chunkedBody_body :: Lens' ChunkedBody (ConduitM () ByteString (ResourceT IO) ())

chunkedBody_length :: Lens' ChunkedBody Integer

chunkedBody_size :: Lens' ChunkedBody ChunkSize

defaultChunkSize :: ChunkSize

The default chunk size of 128 KB. The minimum chunk size accepted by AWS is 8 KB, unless the entirety of the request is below this threshold.

A chunk size of 64 KB or higher is recommended for performance reasons.

_ChunkSize :: Iso' ChunkSize Int

sinkBody :: MonadIO m => ResponseBody -> ConduitM ByteString Void (ResourceT IO) a -> m a

Connect a Sink to a response stream.

fuseStream :: ResponseBody -> ConduitM ByteString ByteString (ResourceT IO) () -> ResponseBody

_ResponseBody :: Iso' ResponseBody (ConduitM () ByteString (ResourceT IO) ())

getFileSize :: MonadIO m => FilePath -> m Integer

Convenience function for obtaining the size of a file.

newtype ResponseBody

A streaming, exception safe response body.

newtype for show/orhpan instance purposes.

Constructors

ResponseBody

Fields

• body :: ConduitM () ByteString (ResourceT IO) ()

Instances

Generic ResponseBody

Defined in Amazonka.Data.Body

Associated Types

type Rep ResponseBody :: Type -> Type

Methods

from :: ResponseBody -> Rep ResponseBody x

to :: Rep ResponseBody x -> ResponseBody

Show ResponseBody

Defined in Amazonka.Data.Body

Methods

showsPrec :: Int -> ResponseBody -> ShowS

show :: ResponseBody -> String

showList :: [ResponseBody] -> ShowS

type Rep ResponseBody

Defined in Amazonka.Data.Body

type Rep ResponseBody = D1 ('MetaData "ResponseBody" "Amazonka.Data.Body" "amazonka-core-2.0-BFuA7FRvuklLoYhn4b6A6p" 'True) (C1 ('MetaCons "ResponseBody" 'PrefixI 'True) (S1 ('MetaSel ('Just "body") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (ConduitM () ByteString (ResourceT IO) ()))))

newtype ChunkSize

Specifies the transmitted size of the 'Transfer-Encoding' chunks.

See: defaultChunk.

Constructors

ChunkSize Int

Instances

ToLog ChunkSize

Defined in Amazonka.Data.Body

Methods

build :: ChunkSize -> ByteStringBuilder

Enum ChunkSize

Defined in Amazonka.Data.Body

Methods

succ :: ChunkSize -> ChunkSize

pred :: ChunkSize -> ChunkSize

toEnum :: Int -> ChunkSize

fromEnum :: ChunkSize -> Int

enumFrom :: ChunkSize -> [ChunkSize]

enumFromThen :: ChunkSize -> ChunkSize -> [ChunkSize]

enumFromTo :: ChunkSize -> ChunkSize -> [ChunkSize]

enumFromThenTo :: ChunkSize -> ChunkSize -> ChunkSize -> [ChunkSize]

Num ChunkSize

Defined in Amazonka.Data.Body

Methods

(+) :: ChunkSize -> ChunkSize -> ChunkSize

(-) :: ChunkSize -> ChunkSize -> ChunkSize

(*) :: ChunkSize -> ChunkSize -> ChunkSize

negate :: ChunkSize -> ChunkSize

abs :: ChunkSize -> ChunkSize

signum :: ChunkSize -> ChunkSize

fromInteger :: Integer -> ChunkSize

Integral ChunkSize

Defined in Amazonka.Data.Body

Methods

quot :: ChunkSize -> ChunkSize -> ChunkSize

rem :: ChunkSize -> ChunkSize -> ChunkSize

div :: ChunkSize -> ChunkSize -> ChunkSize

mod :: ChunkSize -> ChunkSize -> ChunkSize

quotRem :: ChunkSize -> ChunkSize -> (ChunkSize, ChunkSize)

divMod :: ChunkSize -> ChunkSize -> (ChunkSize, ChunkSize)

toInteger :: ChunkSize -> Integer

Real ChunkSize

Defined in Amazonka.Data.Body

Methods

toRational :: ChunkSize -> Rational

Show ChunkSize

Defined in Amazonka.Data.Body

Methods

showsPrec :: Int -> ChunkSize -> ShowS

show :: ChunkSize -> String

showList :: [ChunkSize] -> ShowS

Eq ChunkSize

Defined in Amazonka.Data.Body

Methods

(==) :: ChunkSize -> ChunkSize -> Bool

(/=) :: ChunkSize -> ChunkSize -> Bool

Ord ChunkSize

Defined in Amazonka.Data.Body

Methods

compare :: ChunkSize -> ChunkSize -> Ordering

(<) :: ChunkSize -> ChunkSize -> Bool

(<=) :: ChunkSize -> ChunkSize -> Bool

(>) :: ChunkSize -> ChunkSize -> Bool

(>=) :: ChunkSize -> ChunkSize -> Bool

max :: ChunkSize -> ChunkSize -> ChunkSize

min :: ChunkSize -> ChunkSize -> ChunkSize

data ChunkedBody

An opaque request body which will be transmitted via Transfer-Encoding: chunked.

Invariant: Only services that support chunked encoding can accept a ChunkedBody. (Currently S3.) This is enforced by the type signatures emitted by the generator.

Constructors

ChunkedBody

Fields

• size :: ChunkSize
• length :: Integer
• body :: ConduitM () ByteString (ResourceT IO) ()

Instances

ToBody ChunkedBody

Defined in Amazonka.Data.Body

Methods

toBody :: ChunkedBody -> RequestBody

Show ChunkedBody

Defined in Amazonka.Data.Body

Methods

showsPrec :: Int -> ChunkedBody -> ShowS

show :: ChunkedBody -> String

showList :: [ChunkedBody] -> ShowS

data HashedBody

An opaque request body containing a SHA256 hash.

Constructors

HashedStream (Digest SHA256) !Integer (ConduitM () ByteString (ResourceT IO) ())

HashedBytes (Digest SHA256) ByteString

Instances

ToBody HashedBody

Defined in Amazonka.Data.Body

Methods

toBody :: HashedBody -> RequestBody

ToHashedBody HashedBody

Defined in Amazonka.Data.Body

Methods

toHashed :: HashedBody -> HashedBody

IsString HashedBody

Defined in Amazonka.Data.Body

Methods

fromString :: String -> HashedBody

Show HashedBody

Defined in Amazonka.Data.Body

Methods

showsPrec :: Int -> HashedBody -> ShowS

show :: HashedBody -> String

showList :: [HashedBody] -> ShowS

data RequestBody

Invariant: only services that support both standard and chunked signing expose RequestBody as a parameter.

Constructors

Chunked ChunkedBody

Currently S3 only, see ChunkedBody for details.

Hashed HashedBody

Instances

ToBody RequestBody

Defined in Amazonka.Data.Body

Methods

toBody :: RequestBody -> RequestBody

IsString RequestBody

Defined in Amazonka.Data.Body

Methods

fromString :: String -> RequestBody

Show RequestBody

Defined in Amazonka.Data.Body

Methods

showsPrec :: Int -> RequestBody -> ShowS

show :: RequestBody -> String

showList :: [RequestBody] -> ShowS

class ToHashedBody a where

Anything that can be safely converted to a HashedBody.

Methods

toHashed :: a -> HashedBody

Convert a value to a hashed request body.

Instances

ToHashedBody Value

Defined in Amazonka.Data.Body

Methods

toHashed :: Value -> HashedBody

ToHashedBody Base64

Defined in Amazonka.Data.Base64

Methods

toHashed :: Base64 -> HashedBody

ToHashedBody HashedBody

Defined in Amazonka.Data.Body

Methods

toHashed :: HashedBody -> HashedBody

ToHashedBody QueryString

Defined in Amazonka.Data.Body

Methods

toHashed :: QueryString -> HashedBody

ToHashedBody ByteStringLazy

Defined in Amazonka.Data.Body

Methods

toHashed :: ByteStringLazy -> HashedBody

ToHashedBody TextLazy

Defined in Amazonka.Data.Body

Methods

toHashed :: TextLazy -> HashedBody

ToHashedBody ByteString

Defined in Amazonka.Data.Body

Methods

toHashed :: ByteString -> HashedBody

ToHashedBody Text

Defined in Amazonka.Data.Body

Methods

toHashed :: Text -> HashedBody

ToHashedBody Element

Defined in Amazonka.Data.Body

Methods

toHashed :: Element -> HashedBody

ToHashedBody String

Defined in Amazonka.Data.Body

Methods

toHashed :: String -> HashedBody

ToHashedBody (KeyMap Value)

Defined in Amazonka.Data.Body

Methods

toHashed :: KeyMap Value -> HashedBody

class ToBody a where

Anything that can be converted to a streaming request Body.

Minimal complete definition

Nothing

Methods

toBody :: a -> RequestBody

Convert a value to a request body.

Instances

ToBody Value

Defined in Amazonka.Data.Body

Methods

toBody :: Value -> RequestBody

ToBody Base64

Defined in Amazonka.Data.Base64

Methods

toBody :: Base64 -> RequestBody

ToBody ChunkedBody

Defined in Amazonka.Data.Body

Methods

toBody :: ChunkedBody -> RequestBody

ToBody HashedBody

Defined in Amazonka.Data.Body

Methods

toBody :: HashedBody -> RequestBody

ToBody RequestBody

Defined in Amazonka.Data.Body

Methods

toBody :: RequestBody -> RequestBody

ToBody QueryString

Defined in Amazonka.Data.Body

Methods

toBody :: QueryString -> RequestBody

ToBody ByteStringLazy

Defined in Amazonka.Data.Body

Methods

toBody :: ByteStringLazy -> RequestBody

ToBody TextLazy

Defined in Amazonka.Data.Body

Methods

toBody :: TextLazy -> RequestBody

ToBody ByteString

Defined in Amazonka.Data.Body

Methods

toBody :: ByteString -> RequestBody

ToBody Text

Defined in Amazonka.Data.Body

Methods

toBody :: Text -> RequestBody

ToBody Element

Defined in Amazonka.Data.Body

Methods

toBody :: Element -> RequestBody

ToBody String

Defined in Amazonka.Data.Body

Methods

toBody :: String -> RequestBody

ToBody (KeyMap Value)

Defined in Amazonka.Data.Body

Methods

toBody :: KeyMap Value -> RequestBody

ToBody a => ToBody (Sensitive a)

Defined in Amazonka.Data.Sensitive

Methods

toBody :: Sensitive a -> RequestBody

ToHashedBody a => ToBody (Maybe a)

Defined in Amazonka.Data.Body

Methods

toBody :: Maybe a -> RequestBody

buildLines :: [ByteStringBuilder] -> ByteStringBuilder

Intercalate a list of ByteStringBuilders with newlines.

class ToLog a where

Methods

build :: a -> ByteStringBuilder

Convert a value to a loggable builder.

Instances

ToLog AuthError

Defined in Amazonka.Auth.Exception

Methods

build :: AuthError -> ByteStringBuilder

ToLog