Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

GetTimeSeriesDataPoint

Gets the existing data point for the asset.

Request Syntax


GET /v2/domains/domainIdentifier/entities/entityType/entityIdentifier/time-series-data-points/identifier?formName=formName HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

domainIdentifier

The ID of the Amazon DataZone domain that houses the asset for which you want to get the data point.

Pattern: dzd[-_][a-zA-Z0-9_-]{1,36}

Required: Yes

entityIdentifier

The ID of the asset for which you want to get the data point.

Pattern: [a-zA-Z0-9_-]{1,36}

Required: Yes

entityType

The type of the asset for which you want to get the data point.

Valid Values: ASSET | LISTING

Required: Yes

formName

The name of the time series form that houses the data point that you want to get.

Length Constraints: Minimum length of 1. Maximum length of 128.

Required: Yes

identifier

The ID of the data point that you want to get.

Pattern: [a-zA-Z0-9_-]{1,36}

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "domainId": "string",
   "entityId": "string",
   "entityType": "string",
   "form": { 
      "content": "string",
      "formName": "string",
      "id": "string",
      "timestamp": number,
      "typeIdentifier": "string",
      "typeRevision": "string"
   },
   "formName": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

domainId

The ID of the Amazon DataZone domain that houses the asset data point that you want to get.

Type: String

Pattern: dzd[-_][a-zA-Z0-9_-]{1,36}

entityId

The ID of the asset for which you want to get the data point.

Type: String

Pattern: [a-zA-Z0-9_-]{1,36}

entityType

The type of the asset for which you want to get the data point.

Type: String

Valid Values: ASSET | LISTING

form

The time series form that houses the data point that you want to get.

Type: TimeSeriesDataPointFormOutput object

formName

The name of the time series form that houses the data point that you want to get.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

InternalServerException

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

HTTP Status Code: 500

ResourceNotFoundException

The specified resource cannot be found.

HTTP Status Code: 404

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

UnauthorizedException

You do not have permission to perform this action.

HTTP Status Code: 401

ValidationException

The input fails to satisfy the constraints specified by the AWS service.

HTTP Status Code: 400