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 |
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
- data CreateImpersonationRole = CreateImpersonationRole' {}
- newCreateImpersonationRole :: Text -> Text -> ImpersonationRoleType -> CreateImpersonationRole
- createImpersonationRole_clientToken :: Lens' CreateImpersonationRole (Maybe Text)
- createImpersonationRole_description :: Lens' CreateImpersonationRole (Maybe Text)
- createImpersonationRole_organizationId :: Lens' CreateImpersonationRole Text
- createImpersonationRole_name :: Lens' CreateImpersonationRole Text
- createImpersonationRole_type :: Lens' CreateImpersonationRole ImpersonationRoleType
- createImpersonationRole_rules :: Lens' CreateImpersonationRole [ImpersonationRule]
- data CreateImpersonationRoleResponse = CreateImpersonationRoleResponse' {}
- newCreateImpersonationRoleResponse :: Int -> CreateImpersonationRoleResponse
- createImpersonationRoleResponse_impersonationRoleId :: Lens' CreateImpersonationRoleResponse (Maybe Text)
- createImpersonationRoleResponse_httpStatus :: Lens' CreateImpersonationRoleResponse Int
Creating a Request
data CreateImpersonationRole Source #
See: newCreateImpersonationRole
smart constructor.
CreateImpersonationRole' | |
|
Instances
newCreateImpersonationRole Source #
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.
CreateImpersonationRoleResponse' | |
|
Instances
Generic CreateImpersonationRoleResponse Source # | |
Read CreateImpersonationRoleResponse Source # | |
Show CreateImpersonationRoleResponse Source # | |
Defined in Amazonka.WorkMail.CreateImpersonationRole | |
NFData CreateImpersonationRoleResponse Source # | |
Defined in Amazonka.WorkMail.CreateImpersonationRole rnf :: CreateImpersonationRoleResponse -> () # | |
Eq CreateImpersonationRoleResponse Source # | |
type Rep CreateImpersonationRoleResponse Source # | |
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 #
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.