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.WorkMail.GetImpersonationRoleEffect

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Tests whether the given impersonation role can impersonate a target user.

Synopsis

Creating a Request

data GetImpersonationRoleEffect Source #

See: newGetImpersonationRoleEffect smart constructor.

Constructors

GetImpersonationRoleEffect'

Fields

organizationId :: Text
The WorkMail organization where the impersonation role is defined.
impersonationRoleId :: Text
The impersonation role ID to test.
targetUser :: Text
The WorkMail organization user chosen to test the impersonation role. The following identity formats are available:
- User ID: 12345678-1234-1234-1234-123456789012 or S-1-1-12-1234567890-123456789-123456789-1234
- Email address: user@domain.tld
- User name: user

Instances

Instances details

ToJSON GetImpersonationRoleEffect Source #
Instance details Defined in Amazonka.WorkMail.GetImpersonationRoleEffect Methods toJSON :: GetImpersonationRoleEffect -> Value # toEncoding :: GetImpersonationRoleEffect -> Encoding # toJSONList :: [GetImpersonationRoleEffect] -> Value # toEncodingList :: [GetImpersonationRoleEffect] -> Encoding #
ToHeaders GetImpersonationRoleEffect Source #
Instance details Defined in Amazonka.WorkMail.GetImpersonationRoleEffect Methods toHeaders :: GetImpersonationRoleEffect -> [Header] #
ToPath GetImpersonationRoleEffect Source #
Instance details Defined in Amazonka.WorkMail.GetImpersonationRoleEffect Methods toPath :: GetImpersonationRoleEffect -> ByteString #
ToQuery GetImpersonationRoleEffect Source #
Instance details Defined in Amazonka.WorkMail.GetImpersonationRoleEffect Methods toQuery :: GetImpersonationRoleEffect -> QueryString #
AWSRequest GetImpersonationRoleEffect Source #
Instance details Defined in Amazonka.WorkMail.GetImpersonationRoleEffect Associated Types type AWSResponse GetImpersonationRoleEffect # Methods request :: (Service -> Service) -> GetImpersonationRoleEffect -> Request GetImpersonationRoleEffect # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetImpersonationRoleEffect -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetImpersonationRoleEffect))) #
Generic GetImpersonationRoleEffect Source #
Instance details Defined in Amazonka.WorkMail.GetImpersonationRoleEffect Associated Types type Rep GetImpersonationRoleEffect :: Type -> Type # Methods from :: GetImpersonationRoleEffect -> Rep GetImpersonationRoleEffect x # to :: Rep GetImpersonationRoleEffect x -> GetImpersonationRoleEffect #
Read GetImpersonationRoleEffect Source #
Instance details Defined in Amazonka.WorkMail.GetImpersonationRoleEffect Methods readsPrec :: Int -> ReadS GetImpersonationRoleEffect # readList :: ReadS [GetImpersonationRoleEffect] # readPrec :: ReadPrec GetImpersonationRoleEffect # readListPrec :: ReadPrec [GetImpersonationRoleEffect] #
Show GetImpersonationRoleEffect Source #
Instance details Defined in Amazonka.WorkMail.GetImpersonationRoleEffect Methods showsPrec :: Int -> GetImpersonationRoleEffect -> ShowS # show :: GetImpersonationRoleEffect -> String # showList :: [GetImpersonationRoleEffect] -> ShowS #
NFData GetImpersonationRoleEffect Source #
Instance details Defined in Amazonka.WorkMail.GetImpersonationRoleEffect Methods rnf :: GetImpersonationRoleEffect -> () #
Eq GetImpersonationRoleEffect Source #
Instance details Defined in Amazonka.WorkMail.GetImpersonationRoleEffect Methods (==) :: GetImpersonationRoleEffect -> GetImpersonationRoleEffect -> Bool # (/=) :: GetImpersonationRoleEffect -> GetImpersonationRoleEffect -> Bool #
Hashable GetImpersonationRoleEffect Source #
Instance details Defined in Amazonka.WorkMail.GetImpersonationRoleEffect Methods hashWithSalt :: Int -> GetImpersonationRoleEffect -> Int # hash :: GetImpersonationRoleEffect -> Int #
type AWSResponse GetImpersonationRoleEffect Source #
Instance details Defined in Amazonka.WorkMail.GetImpersonationRoleEffect type AWSResponse GetImpersonationRoleEffect = GetImpersonationRoleEffectResponse
type Rep GetImpersonationRoleEffect Source #
Instance details Defined in Amazonka.WorkMail.GetImpersonationRoleEffect type Rep GetImpersonationRoleEffect = D1 ('MetaData "GetImpersonationRoleEffect" "Amazonka.WorkMail.GetImpersonationRoleEffect" "amazonka-workmail-2.0-6w5uOhF45UX4mlfLHLnG5b" 'False) (C1 ('MetaCons "GetImpersonationRoleEffect'" 'PrefixI 'True) (S1 ('MetaSel ('Just "organizationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "impersonationRoleId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "targetUser") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newGetImpersonationRoleEffect Source #

Arguments

:: Text	`GetImpersonationRoleEffect`
-> Text	`GetImpersonationRoleEffect`
-> Text	`$sel:targetUser:GetImpersonationRoleEffect'`
-> GetImpersonationRoleEffect

Create a value of GetImpersonationRoleEffect 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:

GetImpersonationRoleEffect, getImpersonationRoleEffect_organizationId - The WorkMail organization where the impersonation role is defined.

GetImpersonationRoleEffect, getImpersonationRoleEffect_impersonationRoleId - The impersonation role ID to test.

$sel:targetUser:GetImpersonationRoleEffect', getImpersonationRoleEffect_targetUser - The WorkMail organization user chosen to test the impersonation role. The following identity formats are available:

User ID: 12345678-1234-1234-1234-123456789012 or S-1-1-12-1234567890-123456789-123456789-1234
Email address: user@domain.tld
User name: user

Request Lenses

getImpersonationRoleEffect_organizationId :: Lens' GetImpersonationRoleEffect Text Source #

The WorkMail organization where the impersonation role is defined.

getImpersonationRoleEffect_impersonationRoleId :: Lens' GetImpersonationRoleEffect Text Source #

The impersonation role ID to test.

getImpersonationRoleEffect_targetUser :: Lens' GetImpersonationRoleEffect Text Source #

The WorkMail organization user chosen to test the impersonation role. The following identity formats are available:

User ID: 12345678-1234-1234-1234-123456789012 or S-1-1-12-1234567890-123456789-123456789-1234
Email address: user@domain.tld
User name: user

Destructuring the Response

data GetImpersonationRoleEffectResponse Source #

See: newGetImpersonationRoleEffectResponse smart constructor.

Constructors

GetImpersonationRoleEffectResponse'
Fields effect :: Maybe AccessEffect Effect of the impersonation role on the target user based on its rules. Available effects are `ALLOW` or `DENY`. matchedRules :: Maybe [ImpersonationMatchedRule] A list of the rules that match the input and produce the configured effect. type' :: Maybe ImpersonationRoleType The impersonation role type. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic GetImpersonationRoleEffectResponse Source #
Instance details Defined in Amazonka.WorkMail.GetImpersonationRoleEffect Associated Types type Rep GetImpersonationRoleEffectResponse :: Type -> Type # Methods from :: GetImpersonationRoleEffectResponse -> Rep GetImpersonationRoleEffectResponse x # to :: Rep GetImpersonationRoleEffectResponse x -> GetImpersonationRoleEffectResponse #
Read GetImpersonationRoleEffectResponse Source #
Instance details Defined in Amazonka.WorkMail.GetImpersonationRoleEffect Methods readsPrec :: Int -> ReadS GetImpersonationRoleEffectResponse # readList :: ReadS [GetImpersonationRoleEffectResponse] # readPrec :: ReadPrec GetImpersonationRoleEffectResponse # readListPrec :: ReadPrec [GetImpersonationRoleEffectResponse] #
Show GetImpersonationRoleEffectResponse Source #
Instance details Defined in Amazonka.WorkMail.GetImpersonationRoleEffect Methods showsPrec :: Int -> GetImpersonationRoleEffectResponse -> ShowS # show :: GetImpersonationRoleEffectResponse -> String # showList :: [GetImpersonationRoleEffectResponse] -> ShowS #
NFData GetImpersonationRoleEffectResponse Source #
Instance details Defined in Amazonka.WorkMail.GetImpersonationRoleEffect Methods rnf :: GetImpersonationRoleEffectResponse -> () #
Eq GetImpersonationRoleEffectResponse Source #
Instance details Defined in Amazonka.WorkMail.GetImpersonationRoleEffect Methods (==) :: GetImpersonationRoleEffectResponse -> GetImpersonationRoleEffectResponse -> Bool # (/=) :: GetImpersonationRoleEffectResponse -> GetImpersonationRoleEffectResponse -> Bool #
type Rep GetImpersonationRoleEffectResponse Source #
Instance details Defined in Amazonka.WorkMail.GetImpersonationRoleEffect type Rep GetImpersonationRoleEffectResponse = D1 ('MetaData "GetImpersonationRoleEffectResponse" "Amazonka.WorkMail.GetImpersonationRoleEffect" "amazonka-workmail-2.0-6w5uOhF45UX4mlfLHLnG5b" 'False) (C1 ('MetaCons "GetImpersonationRoleEffectResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "effect") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AccessEffect)) :: S1 ('MetaSel ('Just "matchedRules") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ImpersonationMatchedRule]))) :: (S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ImpersonationRoleType)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newGetImpersonationRoleEffectResponse Source #

Arguments

:: Int	`$sel:httpStatus:GetImpersonationRoleEffectResponse'`
-> GetImpersonationRoleEffectResponse

Create a value of GetImpersonationRoleEffectResponse 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:

GetImpersonationRoleEffectResponse, getImpersonationRoleEffectResponse_effect - Effect of the impersonation role on the target user based on its rules. Available effects are ALLOW or DENY.

$sel:matchedRules:GetImpersonationRoleEffectResponse', getImpersonationRoleEffectResponse_matchedRules - A list of the rules that match the input and produce the configured effect.

GetImpersonationRoleEffectResponse, getImpersonationRoleEffectResponse_type - The impersonation role type.

$sel:httpStatus:GetImpersonationRoleEffectResponse', getImpersonationRoleEffectResponse_httpStatus - The response's http status code.

Response Lenses

getImpersonationRoleEffectResponse_effect :: Lens' GetImpersonationRoleEffectResponse (Maybe AccessEffect) Source #

Effect of the impersonation role on the target user based on its rules. Available effects are ALLOW or DENY.

getImpersonationRoleEffectResponse_matchedRules :: Lens' GetImpersonationRoleEffectResponse (Maybe [ImpersonationMatchedRule]) Source #

A list of the rules that match the input and produce the configured effect.

getImpersonationRoleEffectResponse_type :: Lens' GetImpersonationRoleEffectResponse (Maybe ImpersonationRoleType) Source #

The impersonation role type.

getImpersonationRoleEffectResponse_httpStatus :: Lens' GetImpersonationRoleEffectResponse Int Source #

The response's http status code.