Create Impersonation Role

workmail_create_impersonation_role

R Documentation

Creates an impersonation role for the given WorkMail organization¶

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.

Usage¶

workmail_create_impersonation_role(ClientToken, OrganizationId, Name,
  Type, Description, Rules)

Arguments¶

ClientToken: The idempotency token for the client request.
OrganizationId: [required] The WorkMail organization to create the new impersonation role within.
Name: [required] The name of the new impersonation role.
Type: [required] The impersonation role's type. The available impersonation role types are READ_ONLY or FULL_ACCESS.
Description: The description of the new impersonation role.
Rules: [required] The list of rules for the impersonation role.

Value¶

A list with the following syntax:

list(
  ImpersonationRoleId = "string"
)

Request syntax¶

svc$create_impersonation_role(
  ClientToken = "string",
  OrganizationId = "string",
  Name = "string",
  Type = "FULL_ACCESS"|"READ_ONLY",
  Description = "string",
  Rules = list(
    list(
      ImpersonationRuleId = "string",
      Name = "string",
      Description = "string",
      Effect = "ALLOW"|"DENY",
      TargetUsers = list(
        "string"
      ),
      NotTargetUsers = list(
        "string"
      )
    )
  )
)