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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates an impersonation role for the given WorkMail organization.

Idempotency ensures that an API request completes no more than one time. With an idempotent request, if the original request completes successfully, any subsequent retries also complete successfully without performing any further actions.

Synopsis

Creating a Request

data CreateImpersonationRole Source #

See: newCreateImpersonationRole smart constructor.

Constructors

CreateImpersonationRole'

Fields

clientToken :: Maybe Text
The idempotency token for the client request.
description :: Maybe Text
The description of the new impersonation role.
organizationId :: Text
The WorkMail organization to create the new impersonation role within.
name :: Text
The name of the new impersonation role.
type' :: ImpersonationRoleType
The impersonation role's type. The available impersonation role types are READ_ONLY or FULL_ACCESS.
rules :: [ImpersonationRule]
The list of rules for the impersonation role.

Instances

Instances details

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

newCreateImpersonationRole Source #

Arguments

:: Text	`CreateImpersonationRole`
-> Text	`CreateImpersonationRole`
-> ImpersonationRoleType	`CreateImpersonationRole`
-> CreateImpersonationRole

Create a value of CreateImpersonationRole 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:clientToken:CreateImpersonationRole', createImpersonationRole_clientToken - The idempotency token for the client request.

CreateImpersonationRole, createImpersonationRole_description - The description of the new impersonation role.

CreateImpersonationRole, createImpersonationRole_organizationId - The WorkMail organization to create the new impersonation role within.

CreateImpersonationRole, createImpersonationRole_name - The name of the new impersonation role.

CreateImpersonationRole, createImpersonationRole_type - The impersonation role's type. The available impersonation role types are READ_ONLY or FULL_ACCESS.

$sel:rules:CreateImpersonationRole', createImpersonationRole_rules - The list of rules for the impersonation role.

Request Lenses

createImpersonationRole_clientToken :: Lens' CreateImpersonationRole (Maybe Text) Source #

The idempotency token for the client request.

createImpersonationRole_description :: Lens' CreateImpersonationRole (Maybe Text) Source #

The description of the new impersonation role.

createImpersonationRole_organizationId :: Lens' CreateImpersonationRole Text Source #

The WorkMail organization to create the new impersonation role within.

createImpersonationRole_name :: Lens' CreateImpersonationRole Text Source #

The name of the new impersonation role.

createImpersonationRole_type :: Lens' CreateImpersonationRole ImpersonationRoleType Source #

The impersonation role's type. The available impersonation role types are READ_ONLY or FULL_ACCESS.

createImpersonationRole_rules :: Lens' CreateImpersonationRole [ImpersonationRule] Source #

The list of rules for the impersonation role.

Destructuring the Response

data CreateImpersonationRoleResponse Source #

See: newCreateImpersonationRoleResponse smart constructor.

Constructors

CreateImpersonationRoleResponse'
Fields impersonationRoleId :: Maybe Text The new impersonation role ID. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newCreateImpersonationRoleResponse Source #

Arguments

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

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

CreateImpersonationRoleResponse, createImpersonationRoleResponse_impersonationRoleId - The new impersonation role ID.

$sel:httpStatus:CreateImpersonationRoleResponse', createImpersonationRoleResponse_httpStatus - The response's http status code.

Response Lenses

createImpersonationRoleResponse_impersonationRoleId :: Lens' CreateImpersonationRoleResponse (Maybe Text) Source #

The new impersonation role ID.

createImpersonationRoleResponse_httpStatus :: Lens' CreateImpersonationRoleResponse Int Source #

The response's http status code.