- 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.
DeleteDomainCommand
Deletes a Amazon DataZone domain.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { DataZoneClient, DeleteDomainCommand } from "@aws-sdk/client-datazone"; // ES Modules import
// const { DataZoneClient, DeleteDomainCommand } = require("@aws-sdk/client-datazone"); // CommonJS import
const client = new DataZoneClient(config);
const input = { // DeleteDomainInput
identifier: "STRING_VALUE", // required
clientToken: "STRING_VALUE",
skipDeletionCheck: true || false,
};
const command = new DeleteDomainCommand(input);
const response = await client.send(command);
// { // DeleteDomainOutput
// status: "CREATING" || "AVAILABLE" || "CREATION_FAILED" || "DELETING" || "DELETED" || "DELETION_FAILED", // required
// };
DeleteDomainCommand Input
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
identifierRequired | string | undefined | The identifier of the Amazon Web Services domain that is to be deleted. |
clientToken | string | undefined | A unique, case-sensitive identifier that is provided to ensure the idempotency of the request. |
skipDeletionCheck | boolean | undefined | Specifies the optional flag to delete all child entities within the domain. |
DeleteDomainCommand Output
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
$metadataRequired | ResponseMetadata | Metadata pertaining to this request. |
statusRequired | DomainStatus | undefined | The status of the domain. |
Throws
Name | Fault | Details |
|---|
Name | Fault | Details |
|---|---|---|
| AccessDeniedException | client | You do not have sufficient access to perform this action. |
| ConflictException | client | There is a conflict while performing this action. |
| InternalServerException | server | The request has failed because of an unknown error, exception or failure. |
| ResourceNotFoundException | client | The specified resource cannot be found. |
| ThrottlingException | client | The request was denied due to request throttling. |
| ValidationException | client | The input fails to satisfy the constraints specified by the Amazon Web Services service. |
| UnauthorizedException | client | You do not have permission to perform this action. |
| DataZoneServiceException | Base exception class for all service exceptions from DataZone service. |