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

AcceptPredictions

Accepts automatically generated business-friendly metadata for your Amazon DataZone assets.

Request Syntax


PUT /v2/domains/domainIdentifier/assets/identifier/accept-predictions?revision=revision HTTP/1.1
Content-type: application/json

{
   "acceptChoices": [ 
      { 
         "editedValue": "string",
         "predictionChoice": number,
         "predictionTarget": "string"
      }
   ],
   "acceptRule": { 
      "rule": "string",
      "threshold": number
   },
   "clientToken": "string"
}

URI Request Parameters

The request uses the following URI parameters.

domainIdentifier

The identifier of the Amazon DataZone domain.

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

Required: Yes

identifier

The identifier of the asset.

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

Required: Yes

revision

The revision that is to be made to the asset.

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

Request Body

The request accepts the following data in JSON format.

acceptChoices

Specifies the prediction (aka, the automatically generated piece of metadata) and the target (for example, a column name) that can be accepted.

Type: Array of AcceptChoice objects

Required: No

acceptRule

Specifies the rule (or the conditions) under which a prediction can be accepted.

Type: AcceptRule object

Required: No

clientToken

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

Type: String

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

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

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "assetId": "string",
   "domainId": "string",
   "revision": "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.

assetId

The ID of the asset.

Type: String

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

domainId

The identifier of the Amazon DataZone domain.

Type: String

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

revision

The revision that is to be made to the asset.

Type: String

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

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

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