Skip to content

Delete Organization

workmail_delete_organization R Documentation

Deletes an WorkMail organization and all underlying AWS resources managed by WorkMail as part of the organization

Description

Deletes an WorkMail organization and all underlying AWS resources managed by WorkMail as part of the organization. You can choose whether to delete the associated directory. For more information, see Removing an organization in the WorkMail Administrator Guide.

Usage

workmail_delete_organization(ClientToken, OrganizationId,
  DeleteDirectory, ForceDelete)

Arguments

ClientToken

The idempotency token associated with the request.

OrganizationId

[required] The organization ID.

DeleteDirectory

[required] If true, deletes the AWS Directory Service directory associated with the organization.

ForceDelete

Deletes a WorkMail organization even if the organization has enabled users.

Value

A list with the following syntax:

list(
  OrganizationId = "string",
  State = "string"
)

Request syntax

svc$delete_organization(
  ClientToken = "string",
  OrganizationId = "string",
  DeleteDirectory = TRUE|FALSE,
  ForceDelete = TRUE|FALSE
)