DeleteEnvironmentCommand

Suggest an Edit

Deletes an environment in Amazon DataZone.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { DataZoneClient, DeleteEnvironmentCommand } from "@aws-sdk/client-datazone"; // ES Modules import
// const { DataZoneClient, DeleteEnvironmentCommand } = require("@aws-sdk/client-datazone"); // CommonJS import
const client = new DataZoneClient(config);
const input = { // DeleteEnvironmentInput
  domainIdentifier: "STRING_VALUE", // required
  identifier: "STRING_VALUE", // required
};
const command = new DeleteEnvironmentCommand(input);
const response = await client.send(command);
// {};

DeleteEnvironmentCommand Input

See DeleteEnvironmentCommandInput for more details

Parameter
Type
Description
domainIdentifier
Required
string | undefined

The ID of the Amazon DataZone domain in which the environment is deleted.

identifier
Required
string | undefined

The identifier of the environment that is to be deleted.

DeleteEnvironmentCommand Output

See DeleteEnvironmentCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.

Throws

Name
Fault
Details
AccessDeniedException
client

You do not have sufficient access to perform 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.