Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Chime.Types.UserError

Description

Synopsis

data UserError = UserError' {
- errorCode :: Maybe ErrorCode
- errorMessage :: Maybe Text
- userId :: Maybe Text
}
newUserError :: UserError
userError_errorCode :: Lens' UserError (Maybe ErrorCode)
userError_errorMessage :: Lens' UserError (Maybe Text)
userError_userId :: Lens' UserError (Maybe Text)

Documentation

data UserError Source #

The list of errors returned when errors are encountered during the BatchSuspendUser, BatchUnsuspendUser, or BatchUpdateUser actions. This includes user IDs, error codes, and error messages.

See: newUserError smart constructor.

Constructors

UserError'
Fields errorCode :: Maybe ErrorCode The error code. errorMessage :: Maybe Text The error message. userId :: Maybe Text The user ID for which the action failed.

Instances

Instances details

FromJSON UserError Source #
Instance details Defined in Amazonka.Chime.Types.UserError Methods parseJSON :: Value -> Parser UserError # parseJSONList :: Value -> Parser [UserError] #
Generic UserError Source #
Instance details Defined in Amazonka.Chime.Types.UserError Associated Types type Rep UserError :: Type -> Type # Methods from :: UserError -> Rep UserError x # to :: Rep UserError x -> UserError #
Read UserError Source #
Instance details Defined in Amazonka.Chime.Types.UserError Methods readsPrec :: Int -> ReadS UserError # readList :: ReadS [UserError] # readPrec :: ReadPrec UserError # readListPrec :: ReadPrec [UserError] #
Show UserError Source #
Instance details Defined in Amazonka.Chime.Types.UserError Methods showsPrec :: Int -> UserError -> ShowS # show :: UserError -> String # showList :: [UserError] -> ShowS #
NFData UserError Source #
Instance details Defined in Amazonka.Chime.Types.UserError Methods rnf :: UserError -> () #
Eq UserError Source #
Instance details Defined in Amazonka.Chime.Types.UserError Methods (==) :: UserError -> UserError -> Bool # (/=) :: UserError -> UserError -> Bool #
Hashable UserError Source #
Instance details Defined in Amazonka.Chime.Types.UserError Methods hashWithSalt :: Int -> UserError -> Int # hash :: UserError -> Int #
type Rep UserError Source #
Instance details Defined in Amazonka.Chime.Types.UserError type Rep UserError = D1 ('MetaData "UserError" "Amazonka.Chime.Types.UserError" "amazonka-chime-2.0-AQIuSSkHccQ9VXokPBc5Nb" 'False) (C1 ('MetaCons "UserError'" 'PrefixI 'True) (S1 ('MetaSel ('Just "errorCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ErrorCode)) :: (S1 ('MetaSel ('Just "errorMessage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "userId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newUserError :: UserError Source #

Create a value of UserError with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:errorCode:UserError', userError_errorCode - The error code.

$sel:errorMessage:UserError', userError_errorMessage - The error message.

$sel:userId:UserError', userError_userId - The user ID for which the action failed.

userError_errorCode :: Lens' UserError (Maybe ErrorCode) Source #

The error code.

userError_errorMessage :: Lens' UserError (Maybe Text) Source #

The error message.

userError_userId :: Lens' UserError (Maybe Text) Source #

The user ID for which the action failed.