DeleteTimeSeriesDataPointsCommand

Suggest an Edit

Deletes the specified time series form for the specified asset.

Example Syntax

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

import { DataZoneClient, DeleteTimeSeriesDataPointsCommand } from "@aws-sdk/client-datazone"; // ES Modules import
// const { DataZoneClient, DeleteTimeSeriesDataPointsCommand } = require("@aws-sdk/client-datazone"); // CommonJS import
const client = new DataZoneClient(config);
const input = { // DeleteTimeSeriesDataPointsInput
  domainIdentifier: "STRING_VALUE", // required
  entityIdentifier: "STRING_VALUE", // required
  entityType: "ASSET" || "LISTING", // required
  formName: "STRING_VALUE", // required
  clientToken: "STRING_VALUE",
};
const command = new DeleteTimeSeriesDataPointsCommand(input);
const response = await client.send(command);
// {};

DeleteTimeSeriesDataPointsCommand Input

See DeleteTimeSeriesDataPointsCommandInput for more details

Parameter
Type
Description
domainIdentifier
Required
string | undefined

The ID of the Amazon DataZone domain that houses the asset for which you want to delete a time series form.

entityIdentifier
Required
string | undefined

The ID of the asset for which you want to delete a time series form.

entityType
Required
TimeSeriesEntityType | undefined

The type of the asset for which you want to delete a time series form.

formName
Required
string | undefined

The name of the time series form that you want to delete.

clientToken
string | undefined

A unique, case-sensitive identifier to ensure idempotency of the request. This field is automatically populated if not provided.

DeleteTimeSeriesDataPointsCommand Output

See DeleteTimeSeriesDataPointsCommandOutput 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.