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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Adds a new access control rule for the specified organization. The rule allows or denies access to the organization for the specified IPv4 addresses, access protocol actions, user IDs and impersonation IDs. Adding a new rule with the same name as an existing rule replaces the older rule.

Synopsis

data PutAccessControlRule = PutAccessControlRule' {
- actions :: Maybe [Text]
- impersonationRoleIds :: Maybe [Text]
- ipRanges :: Maybe [Text]
- notActions :: Maybe [Text]
- notImpersonationRoleIds :: Maybe [Text]
- notIpRanges :: Maybe [Text]
- notUserIds :: Maybe [Text]
- userIds :: Maybe [Text]
- name :: Text
- effect :: AccessControlRuleEffect
- description :: Text
- organizationId :: Text
}
newPutAccessControlRule :: Text -> AccessControlRuleEffect -> Text -> Text -> PutAccessControlRule
putAccessControlRule_actions :: Lens' PutAccessControlRule (Maybe [Text])
putAccessControlRule_impersonationRoleIds :: Lens' PutAccessControlRule (Maybe [Text])
putAccessControlRule_ipRanges :: Lens' PutAccessControlRule (Maybe [Text])
putAccessControlRule_notActions :: Lens' PutAccessControlRule (Maybe [Text])
putAccessControlRule_notImpersonationRoleIds :: Lens' PutAccessControlRule (Maybe [Text])
putAccessControlRule_notIpRanges :: Lens' PutAccessControlRule (Maybe [Text])
putAccessControlRule_notUserIds :: Lens' PutAccessControlRule (Maybe [Text])
putAccessControlRule_userIds :: Lens' PutAccessControlRule (Maybe [Text])
putAccessControlRule_name :: Lens' PutAccessControlRule Text
putAccessControlRule_effect :: Lens' PutAccessControlRule AccessControlRuleEffect
putAccessControlRule_description :: Lens' PutAccessControlRule Text
putAccessControlRule_organizationId :: Lens' PutAccessControlRule Text
data PutAccessControlRuleResponse = PutAccessControlRuleResponse' {
- httpStatus :: Int
}
newPutAccessControlRuleResponse :: Int -> PutAccessControlRuleResponse
putAccessControlRuleResponse_httpStatus :: Lens' PutAccessControlRuleResponse Int

Creating a Request

data PutAccessControlRule Source #

See: newPutAccessControlRule smart constructor.

Constructors

PutAccessControlRule'

Fields

actions :: Maybe [Text]
Access protocol actions to include in the rule. Valid values include ActiveSync, AutoDiscover, EWS, IMAP, SMTP, WindowsOutlook, and WebMail.
impersonationRoleIds :: Maybe [Text]
Impersonation role IDs to include in the rule.
ipRanges :: Maybe [Text]
IPv4 CIDR ranges to include in the rule.
notActions :: Maybe [Text]
Access protocol actions to exclude from the rule. Valid values include ActiveSync, AutoDiscover, EWS, IMAP, SMTP, WindowsOutlook, and WebMail.
notImpersonationRoleIds :: Maybe [Text]
Impersonation role IDs to exclude from the rule.
notIpRanges :: Maybe [Text]
IPv4 CIDR ranges to exclude from the rule.
notUserIds :: Maybe [Text]
User IDs to exclude from the rule.
userIds :: Maybe [Text]
User IDs to include in the rule.
name :: Text
The rule name.
effect :: AccessControlRuleEffect
The rule effect.
description :: Text
The rule description.
organizationId :: Text
The identifier of the organization.

Instances

Instances details

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

newPutAccessControlRule Source #

Arguments

:: Text	`PutAccessControlRule`
-> AccessControlRuleEffect	`PutAccessControlRule`
-> Text	`PutAccessControlRule`
-> Text	`PutAccessControlRule`
-> PutAccessControlRule

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

PutAccessControlRule, putAccessControlRule_actions - Access protocol actions to include in the rule. Valid values include ActiveSync, AutoDiscover, EWS, IMAP, SMTP, WindowsOutlook, and WebMail.

PutAccessControlRule, putAccessControlRule_impersonationRoleIds - Impersonation role IDs to include in the rule.

PutAccessControlRule, putAccessControlRule_ipRanges - IPv4 CIDR ranges to include in the rule.

PutAccessControlRule, putAccessControlRule_notActions - Access protocol actions to exclude from the rule. Valid values include ActiveSync, AutoDiscover, EWS, IMAP, SMTP, WindowsOutlook, and WebMail.

PutAccessControlRule, putAccessControlRule_notImpersonationRoleIds - Impersonation role IDs to exclude from the rule.

PutAccessControlRule, putAccessControlRule_notIpRanges - IPv4 CIDR ranges to exclude from the rule.

PutAccessControlRule, putAccessControlRule_notUserIds - User IDs to exclude from the rule.

PutAccessControlRule, putAccessControlRule_userIds - User IDs to include in the rule.

PutAccessControlRule, putAccessControlRule_name - The rule name.

PutAccessControlRule, putAccessControlRule_effect - The rule effect.

PutAccessControlRule, putAccessControlRule_description - The rule description.

PutAccessControlRule, putAccessControlRule_organizationId - The identifier of the organization.

Request Lenses

putAccessControlRule_actions :: Lens' PutAccessControlRule (Maybe [Text]) Source #

Access protocol actions to include in the rule. Valid values include ActiveSync, AutoDiscover, EWS, IMAP, SMTP, WindowsOutlook, and WebMail.

putAccessControlRule_impersonationRoleIds :: Lens' PutAccessControlRule (Maybe [Text]) Source #

Impersonation role IDs to include in the rule.

putAccessControlRule_ipRanges :: Lens' PutAccessControlRule (Maybe [Text]) Source #

IPv4 CIDR ranges to include in the rule.

putAccessControlRule_notActions :: Lens' PutAccessControlRule (Maybe [Text]) Source #

Access protocol actions to exclude from the rule. Valid values include ActiveSync, AutoDiscover, EWS, IMAP, SMTP, WindowsOutlook, and WebMail.

putAccessControlRule_notImpersonationRoleIds :: Lens' PutAccessControlRule (Maybe [Text]) Source #

Impersonation role IDs to exclude from the rule.

putAccessControlRule_notIpRanges :: Lens' PutAccessControlRule (Maybe [Text]) Source #

IPv4 CIDR ranges to exclude from the rule.

putAccessControlRule_notUserIds :: Lens' PutAccessControlRule (Maybe [Text]) Source #

User IDs to exclude from the rule.

putAccessControlRule_userIds :: Lens' PutAccessControlRule (Maybe [Text]) Source #

User IDs to include in the rule.

putAccessControlRule_name :: Lens' PutAccessControlRule Text Source #

The rule name.

putAccessControlRule_effect :: Lens' PutAccessControlRule AccessControlRuleEffect Source #

The rule effect.

putAccessControlRule_description :: Lens' PutAccessControlRule Text Source #

The rule description.

putAccessControlRule_organizationId :: Lens' PutAccessControlRule Text Source #

The identifier of the organization.

Destructuring the Response

data PutAccessControlRuleResponse Source #

See: newPutAccessControlRuleResponse smart constructor.

Constructors

PutAccessControlRuleResponse'
Fields httpStatus :: Int The response's http status code.

Instances

Instances details

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

newPutAccessControlRuleResponse Source #

Arguments

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

Create a value of PutAccessControlRuleResponse 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:httpStatus:PutAccessControlRuleResponse', putAccessControlRuleResponse_httpStatus - The response's http status code.

Response Lenses

putAccessControlRuleResponse_httpStatus :: Lens' PutAccessControlRuleResponse Int Source #

The response's http status code.