- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
DeleteAccountCommand
Deletes the specified Amazon Chime account. You must suspend all users before deleting Team
account. You can use the BatchSuspendUser action to dodo.
For EnterpriseLWA
and EnterpriseAD
accounts, you must release the claimed domains for your Amazon Chime account before deletion. As soon as you release the domain, all users under that account are suspended.
Deleted accounts appear in your Disabled
accounts list for 90 days. To restore deleted account from your Disabled
accounts list, you must contact AWS Support.
After 90 days, deleted accounts are permanently removed from your Disabled
accounts list.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { ChimeClient, DeleteAccountCommand } from "@aws-sdk/client-chime"; // ES Modules import
// const { ChimeClient, DeleteAccountCommand } = require("@aws-sdk/client-chime"); // CommonJS import
const client = new ChimeClient(config);
const input = { // DeleteAccountRequest
AccountId: "STRING_VALUE", // required
};
const command = new DeleteAccountCommand(input);
const response = await client.send(command);
// {};
DeleteAccountCommand Input
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
AccountId Required | string | undefined | The Amazon Chime account ID. |
DeleteAccountCommand Output
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
Throws
Name | Fault | Details |
---|
Name | Fault | Details |
---|---|---|
BadRequestException | client | The input parameters don't match the service's restrictions. |
ForbiddenException | client | The client is permanently forbidden from making the request. |
NotFoundException | client | One or more of the resources in the request does not exist in the system. |
ServiceFailureException | server | The service encountered an unexpected error. |
ServiceUnavailableException | server | The service is currently unavailable. |
ThrottledClientException | client | The client exceeded its request rate limit. |
UnauthorizedClientException | client | The client is not currently authorized to make the request. |
UnprocessableEntityException | client | The request was well-formed but was unable to be followed due to semantic errors. |
ChimeServiceException | Base exception class for all service exceptions from Chime service. |