- 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.
DeleteMetricStreamCommand
Permanently deletes the metric stream that you specify.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { CloudWatchClient, DeleteMetricStreamCommand } from "@aws-sdk/client-cloudwatch"; // ES Modules import
// const { CloudWatchClient, DeleteMetricStreamCommand } = require("@aws-sdk/client-cloudwatch"); // CommonJS import
const client = new CloudWatchClient(config);
const input = { // DeleteMetricStreamInput
Name: "STRING_VALUE", // required
};
const command = new DeleteMetricStreamCommand(input);
const response = await client.send(command);
// {};
DeleteMetricStreamCommand Input
See DeleteMetricStreamCommandInput for more details
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
NameRequired | string | undefined | The name of the metric stream to delete. |
DeleteMetricStreamCommand Output
See DeleteMetricStreamCommandOutput for details
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
$metadataRequired | ResponseMetadata | Metadata pertaining to this request. |
Throws
Name | Fault | Details |
|---|
Name | Fault | Details |
|---|---|---|
| InternalServiceFault | server | Request processing has failed due to some unknown error, exception, or failure. |
| InvalidParameterValueException | client | The value of an input parameter is bad or out-of-range. |
| MissingRequiredParameterException | client | An input parameter that is required is missing. |
| CloudWatchServiceException | Base exception class for all service exceptions from CloudWatch service. |