delete_organization
¶
delete_organization(
organization_id: OrganizationId,
delete_directory: Boolean,
*,
config_overrides: Optional[WorkMailClientConfig] = None,
client_token: Optional[IdempotencyClientToken] = None,
force_delete: Optional[Boolean] = None,
delete_identity_center_application: Optional[Boolean] = None,
) -> DeleteOrganizationResponse
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.
Parameters:
-
client_token(Optional[IdempotencyClientToken], default:None) –The idempotency token associated with the request.
-
organization_id(OrganizationId) –The organization ID.
-
delete_directory(Boolean) –If true, deletes the AWS Directory Service directory associated with the organization.
-
force_delete(Optional[Boolean], default:None) –Deletes a WorkMail organization even if the organization has enabled users.
-
delete_identity_center_application(Optional[Boolean], default:None) –Deletes IAM Identity Center application for WorkMail. This action does not affect authentication settings for any organization.
Raises:
-
InvalidParameterException–One or more of the input parameters don't match the service's restrictions.
-
OrganizationNotFoundException–An operation received a valid organization identifier that either doesn't belong or exist in the system.
-
OrganizationStateException–The organization must have a valid state to perform certain operations on the organization or its members.
-
UnknownServiceError–The service returned an error code this client does not model.
Source code in docs_src/capo_workmail/_services/work_mail.py
1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 | |