Skip to content

CreateImpersonationRoleRequest

Source code in docs_src/capo_workmail/types/create_impersonation_role_request.py 
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
class CreateImpersonationRoleRequest(TypedDict, closed=True):
    client_token: NotRequired[
        "capo_workmail.types.idempotency_client_token.IdempotencyClientToken"
    ]
    """<p>The idempotency token for the client request.</p>"""
    organization_id: "capo_workmail.types.organization_id.OrganizationId"
    """<p>The WorkMail organization to create the new impersonation role within.</p>"""
    name: "capo_workmail.types.impersonation_role_name.ImpersonationRoleName"
    """<p>The name of the new impersonation role.</p>"""
    type: "capo_workmail.types.impersonation_role_type.ImpersonationRoleType"
    """<p>The impersonation role's type. The available impersonation role types are <code>READ_ONLY</code> or <code>FULL_ACCESS</code>.</p>"""
    description: NotRequired[
        "capo_workmail.types.impersonation_role_description.ImpersonationRoleDescription"
    ]
    """<p>The description of the new impersonation role.</p>"""
    rules: "capo_workmail.types.impersonation_rule_list.ImpersonationRuleList"
    """<p>The list of rules for the impersonation role.</p>"""

client_token instance-attribute 

client_token: NotRequired[IdempotencyClientToken]

The idempotency token for the client request.

description instance-attribute 

description: NotRequired[ImpersonationRoleDescription]

The description of the new impersonation role.

name instance-attribute 

name: ImpersonationRoleName

The name of the new impersonation role.

organization_id instance-attribute 

organization_id: OrganizationId

The WorkMail organization to create the new impersonation role within.

rules instance-attribute 

rules: ImpersonationRuleList

The list of rules for the impersonation role.

type instance-attribute 

type: ImpersonationRoleType

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