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

Amazonka.Auth.Exception

Description

Exception for errors involving AWS authentication.

Synopsis

data AuthError
class AsAuthError a where
- _AuthError :: Prism' a AuthError
- _RetrievalError :: Prism' a HttpException
- _MissingEnvError :: Prism' a Text
- _MissingFileError :: Prism' a FilePath
- _InvalidFileError :: Prism' a Text
- _InvalidIAMError :: Prism' a Text

Documentation

data AuthError Source #

An error thrown when attempting to read AuthN/AuthZ information.

Constructors

RetrievalError HttpException
MissingEnvError Text
MissingFileError FilePath
InvalidFileError Text
InvalidIAMError Text
CredentialChainExhausted

Instances

Instances details

AsAuthError AuthError Source #
Instance details Defined in Amazonka.Auth.Exception Methods _AuthError :: Prism' AuthError AuthError Source # _RetrievalError :: Prism' AuthError HttpException Source # _MissingEnvError :: Prism' AuthError Text Source # _MissingFileError :: Prism' AuthError FilePath Source # _InvalidFileError :: Prism' AuthError Text Source # _InvalidIAMError :: Prism' AuthError Text Source #
ToLog AuthError Source #
Instance details Defined in Amazonka.Auth.Exception Methods build :: AuthError -> ByteStringBuilder #
Exception AuthError Source #
Instance details Defined in Amazonka.Auth.Exception Methods toException :: AuthError -> SomeException # fromException :: SomeException -> Maybe AuthError # displayException :: AuthError -> String #
Generic AuthError Source #
Instance details Defined in Amazonka.Auth.Exception Associated Types type Rep AuthError :: Type -> Type # Methods from :: AuthError -> Rep AuthError x # to :: Rep AuthError x -> AuthError #
Show AuthError Source #
Instance details Defined in Amazonka.Auth.Exception Methods showsPrec :: Int -> AuthError -> ShowS # show :: AuthError -> String # showList :: [AuthError] -> ShowS #
type Rep AuthError Source #
Instance details Defined in Amazonka.Auth.Exception type Rep AuthError = D1 ('MetaData "AuthError" "Amazonka.Auth.Exception" "amazonka-2.0-48plDWnPMAk3PGO79vdSa0" 'False) ((C1 ('MetaCons "RetrievalError" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 HttpException)) :+: (C1 ('MetaCons "MissingEnvError" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :+: C1 ('MetaCons "MissingFileError" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 FilePath)))) :+: (C1 ('MetaCons "InvalidFileError" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :+: (C1 ('MetaCons "InvalidIAMError" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :+: C1 ('MetaCons "CredentialChainExhausted" 'PrefixI 'False) (U1 :: Type -> Type))))

class AsAuthError a where Source #

Minimal complete definition

_AuthError

Methods

_AuthError :: Prism' a AuthError Source #

A general authentication error.

_RetrievalError :: Prism' a HttpException Source #

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

_MissingEnvError :: Prism' a Text Source #

The named environment variable was not found.

_MissingFileError :: Prism' a FilePath Source #

The specified credentials file could not be found.

_InvalidFileError :: Prism' a Text Source #

An error occured parsing the credentials file.

_InvalidIAMError :: Prism' a Text Source #

The specified IAM profile could not be found or deserialised.

Instances

Instances details

AsAuthError AuthError Source #
Instance details Defined in Amazonka.Auth.Exception Methods _AuthError :: Prism' AuthError AuthError Source # _RetrievalError :: Prism' AuthError HttpException Source # _MissingEnvError :: Prism' AuthError Text Source # _MissingFileError :: Prism' AuthError FilePath Source # _InvalidFileError :: Prism' AuthError Text Source # _InvalidIAMError :: Prism' AuthError Text Source #
AsAuthError SomeException Source #
Instance details Defined in Amazonka.Auth.Exception Methods _AuthError :: Prism' SomeException AuthError Source # _RetrievalError :: Prism' SomeException HttpException Source # _MissingEnvError :: Prism' SomeException Text Source # _MissingFileError :: Prism' SomeException FilePath Source # _InvalidFileError :: Prism' SomeException Text Source # _InvalidIAMError :: Prism' SomeException Text Source #