- 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.
GetTimeSeriesDataPointCommand
Gets the existing data point for the asset.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { DataZoneClient, GetTimeSeriesDataPointCommand } from "@aws-sdk/client-datazone"; // ES Modules import
// const { DataZoneClient, GetTimeSeriesDataPointCommand } = require("@aws-sdk/client-datazone"); // CommonJS import
const client = new DataZoneClient(config);
const input = { // GetTimeSeriesDataPointInput
domainIdentifier: "STRING_VALUE", // required
entityIdentifier: "STRING_VALUE", // required
entityType: "ASSET" || "LISTING", // required
identifier: "STRING_VALUE", // required
formName: "STRING_VALUE", // required
};
const command = new GetTimeSeriesDataPointCommand(input);
const response = await client.send(command);
// { // GetTimeSeriesDataPointOutput
// domainId: "STRING_VALUE",
// entityId: "STRING_VALUE",
// entityType: "ASSET" || "LISTING",
// formName: "STRING_VALUE",
// form: { // TimeSeriesDataPointFormOutput
// formName: "STRING_VALUE", // required
// typeIdentifier: "STRING_VALUE", // required
// typeRevision: "STRING_VALUE",
// timestamp: new Date("TIMESTAMP"), // required
// content: "STRING_VALUE",
// id: "STRING_VALUE",
// },
// };
GetTimeSeriesDataPointCommand Input
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
domainIdentifier Required | string | undefined | The ID of the Amazon DataZone domain that houses the asset for which you want to get the data point. |
entityIdentifier Required | string | undefined | The ID of the asset for which you want to get the data point. |
entityType Required | TimeSeriesEntityType | undefined | The type of the asset for which you want to get the data point. |
formName Required | string | undefined | The name of the time series form that houses the data point that you want to get. |
identifier Required | string | undefined | The ID of the data point that you want to get. |
GetTimeSeriesDataPointCommand Output
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
domainId | string | undefined | The ID of the Amazon DataZone domain that houses the asset data point that you want to get. |
entityId | string | undefined | The ID of the asset for which you want to get the data point. |
entityType | TimeSeriesEntityType | undefined | The type of the asset for which you want to get the data point. |
form | TimeSeriesDataPointFormOutput | undefined | The time series form that houses the data point that you want to get. |
formName | string | undefined | The name of the time series form that houses the data point that you want to get. |
Throws
Name | Fault | Details |
---|
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. |