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

PostTimeSeriesDataPoints

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

Request Syntax


POST /v2/domains/domainIdentifier/entities/entityType/entityIdentifier/time-series-data-points HTTP/1.1
Content-type: application/json

{
   "clientToken": "string",
   "forms": [ 
      { 
         "content": "string",
         "formName": "string",
         "timestamp": number,
         "typeIdentifier": "string",
         "typeRevision": "string"
      }
   ]
}

URI Request Parameters

The request uses the following URI parameters.

domainIdentifier

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

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

Required: Yes

entityIdentifier

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

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

Required: Yes

entityType

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

Valid Values: ASSET | LISTING

Required: Yes

Request Body

The request accepts the following data in JSON format.

clientToken

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

Type: String

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

Pattern: ^[\x21-\x7E]+$

Required: No

forms

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

Type: Array of TimeSeriesDataPointFormInput objects

Required: Yes

Response Syntax


HTTP/1.1 201
Content-type: application/json

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

Response Elements

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

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

domainId

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

Type: String

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

entityId

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

Type: String

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

entityType

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

Type: String

Valid Values: ASSET | LISTING

forms

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

Type: Array of TimeSeriesDataPointFormOutput objects

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

ConflictException

There is a conflict while performing this action.

HTTP Status Code: 409

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

ServiceQuotaExceededException

The request has exceeded the specified service quota.

HTTP Status Code: 402

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