Skip to content

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, DeleteIdentityCenterApplication)

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.

  • DeleteIdentityCenterApplication

    Deletes IAM Identity Center application for WorkMail. This action does not affect authentication settings for any organization.

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,
  DeleteIdentityCenterApplication = TRUE|FALSE
)