DeleteDatasetContentCommand

Suggest an Edit

Deletes the content of the specified dataset.

Example Syntax

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

import { IoTAnalyticsClient, DeleteDatasetContentCommand } from "@aws-sdk/client-iotanalytics"; // ES Modules import
// const { IoTAnalyticsClient, DeleteDatasetContentCommand } = require("@aws-sdk/client-iotanalytics"); // CommonJS import
const client = new IoTAnalyticsClient(config);
const input = { // DeleteDatasetContentRequest
  datasetName: "STRING_VALUE", // required
  versionId: "STRING_VALUE",
};
const command = new DeleteDatasetContentCommand(input);
const response = await client.send(command);
// {};

DeleteDatasetContentCommand Input

See DeleteDatasetContentCommandInput for more details

Parameter
Type
Description
datasetName
Required
string | undefined

The name of the dataset whose content is deleted.

versionId
string | undefined

The version of the dataset whose content is deleted. You can also use the strings "$LATEST" or "$LATEST_SUCCEEDED" to delete the latest or latest successfully completed data set. If not specified, "$LATEST_SUCCEEDED" is the default.

DeleteDatasetContentCommand Output

See DeleteDatasetContentCommandOutput for details

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

Throws

Name
Fault
Details
InternalFailureException
server

There was an internal failure.

InvalidRequestException
client

The request was not valid.

ResourceNotFoundException
client

A resource with the specified name could not be found.

ServiceUnavailableException
server

The service is temporarily unavailable.

ThrottlingException
client

The request was denied due to request throttling.

IoTAnalyticsServiceException
Base exception class for all service exceptions from IoTAnalytics service.