DeleteOrganization
Important
End of support notice: On March 31, 2027, AWS will end support for Amazon WorkMail. After March 31, 2027, you will no longer be able to access the WorkMail console or WorkMail resources. For more information, see Amazon WorkMail end of support.
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.
Request Syntax
{
"ClientToken": "string",
"DeleteDirectory": boolean,
"DeleteIdentityCenterApplication": boolean,
"ForceDelete": boolean,
"OrganizationId": "string"
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- ClientToken
-
The idempotency token associated with the request.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
[\x21-\x7e]+Required: No
- DeleteDirectory
-
If true, deletes the AWS Directory Service directory associated with the organization.
Type: Boolean
Required: Yes
- DeleteIdentityCenterApplication
-
Deletes IAM Identity Center application for WorkMail. This action does not affect authentication settings for any organization.
Type: Boolean
Required: No
- ForceDelete
-
Deletes a WorkMail organization even if the organization has enabled users.
Type: Boolean
Required: No
- OrganizationId
-
The organization ID.
Type: String
Length Constraints: Fixed length of 34.
Pattern:
^m-[0-9a-f]{32}$Required: Yes
Response Syntax
{
"OrganizationId": "string",
"State": "string"
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- OrganizationId
-
The organization ID.
Type: String
Length Constraints: Fixed length of 34.
Pattern:
^m-[0-9a-f]{32}$ - State
-
The state of the organization.
Type: String
Length Constraints: Maximum length of 256.
Errors
For information about the errors that are common to all actions, see Common Error Types.
- InvalidParameterException
-
Important
End of support notice: On March 31, 2027, AWS will end support for Amazon WorkMail. After March 31, 2027, you will no longer be able to access the WorkMail console or WorkMail resources. For more information, see Amazon WorkMail end of support.
One or more of the input parameters don't match the service's restrictions.
HTTP Status Code: 400
- OrganizationNotFoundException
-
Important
End of support notice: On March 31, 2027, AWS will end support for Amazon WorkMail. After March 31, 2027, you will no longer be able to access the WorkMail console or WorkMail resources. For more information, see Amazon WorkMail end of support.
An operation received a valid organization identifier that either doesn't belong or exist in the system.
HTTP Status Code: 400
- OrganizationStateException
-
Important
End of support notice: On March 31, 2027, AWS will end support for Amazon WorkMail. After March 31, 2027, you will no longer be able to access the WorkMail console or WorkMail resources. For more information, see Amazon WorkMail end of support.
The organization must have a valid state to perform certain operations on the organization or its members.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
