Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1480317256.9 KB

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.

post/#X-Amz-Target=WorkMailService.CreateImpersonationRole

Headers

X-Amz-Target'WorkMailService.CreateImpersonationRole' required

Request body

ClientTokenstring

The idempotency token for the client request.

OrganizationIdstring required

The WorkMail organization to create the new impersonation role within.

Namestring required

The name of the new impersonation role.

Type'FULL_ACCESS' | 'READ_ONLY' required

The impersonation role's type. The available impersonation role types are <code>READ_ONLY</code> or <code>FULL_ACCESS</code>.

Descriptionstring

The description of the new impersonation role.

Response

Success

ImpersonationRoleIdstring

The new impersonation role ID.