| 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
Description
Tests whether the given impersonation role can impersonate a target user.
Synopsis
- data GetImpersonationRoleEffect = GetImpersonationRoleEffect' {}
- newGetImpersonationRoleEffect :: Text -> Text -> Text -> GetImpersonationRoleEffect
- getImpersonationRoleEffect_organizationId :: Lens' GetImpersonationRoleEffect Text
- getImpersonationRoleEffect_impersonationRoleId :: Lens' GetImpersonationRoleEffect Text
- getImpersonationRoleEffect_targetUser :: Lens' GetImpersonationRoleEffect Text
- data GetImpersonationRoleEffectResponse = GetImpersonationRoleEffectResponse' {}
- newGetImpersonationRoleEffectResponse :: Int -> GetImpersonationRoleEffectResponse
- getImpersonationRoleEffectResponse_effect :: Lens' GetImpersonationRoleEffectResponse (Maybe AccessEffect)
- getImpersonationRoleEffectResponse_matchedRules :: Lens' GetImpersonationRoleEffectResponse (Maybe [ImpersonationMatchedRule])
- getImpersonationRoleEffectResponse_type :: Lens' GetImpersonationRoleEffectResponse (Maybe ImpersonationRoleType)
- getImpersonationRoleEffectResponse_httpStatus :: Lens' GetImpersonationRoleEffectResponse Int
Creating a Request
data GetImpersonationRoleEffect Source #
See: newGetImpersonationRoleEffect smart constructor.
Constructors
| GetImpersonationRoleEffect' | |
Fields
| |
Instances
newGetImpersonationRoleEffect Source #
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> 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-123456789012orS-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-123456789012orS-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
| |
Instances
newGetImpersonationRoleEffectResponse Source #
Arguments
| :: Int | |
| -> 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.