- 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.
DeleteEnvironmentTemplateCommand
If no other major or minor versions of an environment template exist, delete the environment template.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { ProtonClient, DeleteEnvironmentTemplateCommand } from "@aws-sdk/client-proton"; // ES Modules import
// const { ProtonClient, DeleteEnvironmentTemplateCommand } = require("@aws-sdk/client-proton"); // CommonJS import
const client = new ProtonClient(config);
const input = { // DeleteEnvironmentTemplateInput
name: "STRING_VALUE", // required
};
const command = new DeleteEnvironmentTemplateCommand(input);
const response = await client.send(command);
// { // DeleteEnvironmentTemplateOutput
// environmentTemplate: { // EnvironmentTemplate
// name: "STRING_VALUE", // required
// arn: "STRING_VALUE", // required
// createdAt: new Date("TIMESTAMP"), // required
// lastModifiedAt: new Date("TIMESTAMP"), // required
// displayName: "STRING_VALUE",
// description: "STRING_VALUE",
// recommendedVersion: "STRING_VALUE",
// encryptionKey: "STRING_VALUE",
// provisioning: "STRING_VALUE",
// },
// };
DeleteEnvironmentTemplateCommand Input
See DeleteEnvironmentTemplateCommandInput for more details
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
name Required | string | undefined | The name of the environment template to delete. |
DeleteEnvironmentTemplateCommand Output
See DeleteEnvironmentTemplateCommandOutput for details
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
environmentTemplate | EnvironmentTemplate | undefined | The detailed data of the environment template being deleted. |
Throws
Name | Fault | Details |
---|
Name | Fault | Details |
---|---|---|
AccessDeniedException | client | There isn't sufficient access for performing this action. |
ConflictException | client | The request couldn't be made due to a conflicting operation or resource. |
InternalServerException | server | The request failed to register with the service. |
ResourceNotFoundException | client | The requested resource wasn't found. |
ThrottlingException | client | The request was denied due to request throttling. |
ValidationException | client | The input is invalid or an out-of-range value was supplied for the input parameter. |
ProtonServiceException | Base exception class for all service exceptions from Proton service. |