PostTimeSeriesDataPointsCommand

Suggest an Edit

Posts time series data points to Amazon DataZone for the specified asset.

Example Syntax

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

import { DataZoneClient, PostTimeSeriesDataPointsCommand } from "@aws-sdk/client-datazone"; // ES Modules import
// const { DataZoneClient, PostTimeSeriesDataPointsCommand } = require("@aws-sdk/client-datazone"); // CommonJS import
const client = new DataZoneClient(config);
const input = { // PostTimeSeriesDataPointsInput
  domainIdentifier: "STRING_VALUE", // required
  entityIdentifier: "STRING_VALUE", // required
  entityType: "ASSET" || "LISTING", // required
  forms: [ // TimeSeriesDataPointFormInputList // required
    { // TimeSeriesDataPointFormInput
      formName: "STRING_VALUE", // required
      typeIdentifier: "STRING_VALUE", // required
      typeRevision: "STRING_VALUE",
      timestamp: new Date("TIMESTAMP"), // required
      content: "STRING_VALUE",
    },
  ],
  clientToken: "STRING_VALUE",
};
const command = new PostTimeSeriesDataPointsCommand(input);
const response = await client.send(command);
// { // PostTimeSeriesDataPointsOutput
//   domainId: "STRING_VALUE",
//   entityId: "STRING_VALUE",
//   entityType: "ASSET" || "LISTING",
//   forms: [ // TimeSeriesDataPointFormOutputList
//     { // TimeSeriesDataPointFormOutput
//       formName: "STRING_VALUE", // required
//       typeIdentifier: "STRING_VALUE", // required
//       typeRevision: "STRING_VALUE",
//       timestamp: new Date("TIMESTAMP"), // required
//       content: "STRING_VALUE",
//       id: "STRING_VALUE",
//     },
//   ],
// };

PostTimeSeriesDataPointsCommand Input

See PostTimeSeriesDataPointsCommandInput for more details

Parameter
Type
Description
domainIdentifier
Required
string | undefined

The ID of the Amazon DataZone domain in which you want to post time series data points.

entityIdentifier
Required
string | undefined

The ID of the asset for which you want to post time series data points.

entityType
Required
TimeSeriesEntityType | undefined

The type of the asset for which you want to post data points.

forms
Required
TimeSeriesDataPointFormInput[] | undefined

The forms that contain the data points that you want to post.

clientToken
string | undefined

A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.

PostTimeSeriesDataPointsCommand Output

See PostTimeSeriesDataPointsCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
domainId
string | undefined

The ID of the Amazon DataZone domain in which you want to post time series data points.

entityId
string | undefined

The ID of the asset for which you want to post time series data points.

entityType
TimeSeriesEntityType | undefined

The type of the asset for which you want to post data points.

forms
TimeSeriesDataPointFormOutput[] | undefined

The forms that contain the data points that you have posted.

Throws

Name
Fault
Details
AccessDeniedException
client

You do not have sufficient access to perform this action.

ConflictException
client

There is a conflict while performing this action.

InternalServerException
server

The request has failed because of an unknown error, exception or failure.

ResourceNotFoundException
client

The specified resource cannot be found.

ServiceQuotaExceededException
client

The request has exceeded the specified service quota.

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.