- 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.
DeleteExperimentTemplateCommand
Deletes the specified experiment template.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { FisClient, DeleteExperimentTemplateCommand } from "@aws-sdk/client-fis"; // ES Modules import
// const { FisClient, DeleteExperimentTemplateCommand } = require("@aws-sdk/client-fis"); // CommonJS import
const client = new FisClient(config);
const input = { // DeleteExperimentTemplateRequest
id: "STRING_VALUE", // required
};
const command = new DeleteExperimentTemplateCommand(input);
const response = await client.send(command);
// { // DeleteExperimentTemplateResponse
// experimentTemplate: { // ExperimentTemplate
// id: "STRING_VALUE",
// arn: "STRING_VALUE",
// description: "STRING_VALUE",
// targets: { // ExperimentTemplateTargetMap
// "<keys>": { // ExperimentTemplateTarget
// resourceType: "STRING_VALUE",
// resourceArns: [ // ResourceArnList
// "STRING_VALUE",
// ],
// resourceTags: { // TagMap
// "<keys>": "STRING_VALUE",
// },
// filters: [ // ExperimentTemplateTargetFilterList
// { // ExperimentTemplateTargetFilter
// path: "STRING_VALUE",
// values: [ // ExperimentTemplateTargetFilterValues
// "STRING_VALUE",
// ],
// },
// ],
// selectionMode: "STRING_VALUE",
// parameters: { // ExperimentTemplateTargetParameterMap
// "<keys>": "STRING_VALUE",
// },
// },
// },
// actions: { // ExperimentTemplateActionMap
// "<keys>": { // ExperimentTemplateAction
// actionId: "STRING_VALUE",
// description: "STRING_VALUE",
// parameters: { // ExperimentTemplateActionParameterMap
// "<keys>": "STRING_VALUE",
// },
// targets: { // ExperimentTemplateActionTargetMap
// "<keys>": "STRING_VALUE",
// },
// startAfter: [ // ExperimentTemplateActionStartAfterList
// "STRING_VALUE",
// ],
// },
// },
// stopConditions: [ // ExperimentTemplateStopConditionList
// { // ExperimentTemplateStopCondition
// source: "STRING_VALUE",
// value: "STRING_VALUE",
// },
// ],
// creationTime: new Date("TIMESTAMP"),
// lastUpdateTime: new Date("TIMESTAMP"),
// roleArn: "STRING_VALUE",
// tags: {
// "<keys>": "STRING_VALUE",
// },
// logConfiguration: { // ExperimentTemplateLogConfiguration
// cloudWatchLogsConfiguration: { // ExperimentTemplateCloudWatchLogsLogConfiguration
// logGroupArn: "STRING_VALUE",
// },
// s3Configuration: { // ExperimentTemplateS3LogConfiguration
// bucketName: "STRING_VALUE",
// prefix: "STRING_VALUE",
// },
// logSchemaVersion: Number("int"),
// },
// experimentOptions: { // ExperimentTemplateExperimentOptions
// accountTargeting: "single-account" || "multi-account",
// emptyTargetResolutionMode: "fail" || "skip",
// },
// targetAccountConfigurationsCount: Number("long"),
// experimentReportConfiguration: { // ExperimentTemplateReportConfiguration
// outputs: { // ExperimentTemplateReportConfigurationOutputs
// s3Configuration: { // ReportConfigurationS3Output
// bucketName: "STRING_VALUE",
// prefix: "STRING_VALUE",
// },
// },
// dataSources: { // ExperimentTemplateReportConfigurationDataSources
// cloudWatchDashboards: [ // ExperimentTemplateReportConfigurationCloudWatchDashboardList
// { // ExperimentTemplateReportConfigurationCloudWatchDashboard
// dashboardIdentifier: "STRING_VALUE",
// },
// ],
// },
// preExperimentDuration: "STRING_VALUE",
// postExperimentDuration: "STRING_VALUE",
// },
// },
// };
DeleteExperimentTemplateCommand Input
See DeleteExperimentTemplateCommandInput for more details
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
id Required | string | undefined | The ID of the experiment template. |
DeleteExperimentTemplateCommand Output
See DeleteExperimentTemplateCommandOutput for details
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
experimentTemplate | ExperimentTemplate | undefined | Information about the experiment template. |
Throws
Name | Fault | Details |
---|
Name | Fault | Details |
---|---|---|
ResourceNotFoundException | client | The specified resource cannot be found. |
ValidationException | client | The specified input is not valid, or fails to satisfy the constraints for the request. |
FisServiceException | Base exception class for all service exceptions from Fis service. |