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.GetAccessControlEffect

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Gets the effects of an organization's access control rules as they apply to a specified IPv4 address, access protocol action, and user ID or impersonation role ID. You must provide either the user ID or impersonation role ID. Impersonation role ID can only be used with Action EWS.

Synopsis

data GetAccessControlEffect = GetAccessControlEffect' {
- impersonationRoleId :: Maybe Text
- userId :: Maybe Text
- organizationId :: Text
- ipAddress :: Text
- action :: Text
}
newGetAccessControlEffect :: Text -> Text -> Text -> GetAccessControlEffect
getAccessControlEffect_impersonationRoleId :: Lens' GetAccessControlEffect (Maybe Text)
getAccessControlEffect_userId :: Lens' GetAccessControlEffect (Maybe Text)
getAccessControlEffect_organizationId :: Lens' GetAccessControlEffect Text
getAccessControlEffect_ipAddress :: Lens' GetAccessControlEffect Text
getAccessControlEffect_action :: Lens' GetAccessControlEffect Text
data GetAccessControlEffectResponse = GetAccessControlEffectResponse' {
- effect :: Maybe AccessControlRuleEffect
- matchedRules :: Maybe [Text]
- httpStatus :: Int
}
newGetAccessControlEffectResponse :: Int -> GetAccessControlEffectResponse
getAccessControlEffectResponse_effect :: Lens' GetAccessControlEffectResponse (Maybe AccessControlRuleEffect)
getAccessControlEffectResponse_matchedRules :: Lens' GetAccessControlEffectResponse (Maybe [Text])
getAccessControlEffectResponse_httpStatus :: Lens' GetAccessControlEffectResponse Int

Creating a Request

data GetAccessControlEffect Source #

See: newGetAccessControlEffect smart constructor.

Constructors

GetAccessControlEffect'
Fields impersonationRoleId :: Maybe Text The impersonation role ID. userId :: Maybe Text The user ID. organizationId :: Text The identifier for the organization. ipAddress :: Text The IPv4 address. action :: Text The access protocol action. Valid values include `ActiveSync`, `AutoDiscover`, `EWS`, `IMAP`, `SMTP`, `WindowsOutlook`, and `WebMail`.

Instances

Instances details

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

newGetAccessControlEffect Source #

Arguments

:: Text	`GetAccessControlEffect`
-> Text	`$sel:ipAddress:GetAccessControlEffect'`
-> Text	`GetAccessControlEffect`
-> GetAccessControlEffect

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

GetAccessControlEffect, getAccessControlEffect_impersonationRoleId - The impersonation role ID.

GetAccessControlEffect, getAccessControlEffect_userId - The user ID.

GetAccessControlEffect, getAccessControlEffect_organizationId - The identifier for the organization.

$sel:ipAddress:GetAccessControlEffect', getAccessControlEffect_ipAddress - The IPv4 address.

GetAccessControlEffect, getAccessControlEffect_action - The access protocol action. Valid values include ActiveSync, AutoDiscover, EWS, IMAP, SMTP, WindowsOutlook, and WebMail.

Request Lenses

getAccessControlEffect_impersonationRoleId :: Lens' GetAccessControlEffect (Maybe Text) Source #

The impersonation role ID.

getAccessControlEffect_userId :: Lens' GetAccessControlEffect (Maybe Text) Source #

The user ID.

getAccessControlEffect_organizationId :: Lens' GetAccessControlEffect Text Source #

The identifier for the organization.

getAccessControlEffect_ipAddress :: Lens' GetAccessControlEffect Text Source #

The IPv4 address.

getAccessControlEffect_action :: Lens' GetAccessControlEffect Text Source #

The access protocol action. Valid values include ActiveSync, AutoDiscover, EWS, IMAP, SMTP, WindowsOutlook, and WebMail.

Destructuring the Response

data GetAccessControlEffectResponse Source #

See: newGetAccessControlEffectResponse smart constructor.

Constructors

GetAccessControlEffectResponse'
Fields effect :: Maybe AccessControlRuleEffect The rule effect. matchedRules :: Maybe [Text] The rules that match the given parameters, resulting in an effect. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newGetAccessControlEffectResponse Source #

Arguments

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

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

GetAccessControlEffectResponse, getAccessControlEffectResponse_effect - The rule effect.

$sel:matchedRules:GetAccessControlEffectResponse', getAccessControlEffectResponse_matchedRules - The rules that match the given parameters, resulting in an effect.

$sel:httpStatus:GetAccessControlEffectResponse', getAccessControlEffectResponse_httpStatus - The response's http status code.

Response Lenses

getAccessControlEffectResponse_effect :: Lens' GetAccessControlEffectResponse (Maybe AccessControlRuleEffect) Source #

The rule effect.

getAccessControlEffectResponse_matchedRules :: Lens' GetAccessControlEffectResponse (Maybe [Text]) Source #

The rules that match the given parameters, resulting in an effect.

getAccessControlEffectResponse_httpStatus :: Lens' GetAccessControlEffectResponse Int Source #

The response's http status code.