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

CreateAsset

Creates an asset in Amazon DataZone catalog.

Request Syntax


POST /v2/domains/domainIdentifier/assets HTTP/1.1
Content-type: application/json

{
   "clientToken": "string",
   "description": "string",
   "externalIdentifier": "string",
   "formsInput": [ 
      { 
         "content": "string",
         "formName": "string",
         "typeIdentifier": "string",
         "typeRevision": "string"
      }
   ],
   "glossaryTerms": [ "string" ],
   "name": "string",
   "owningProjectIdentifier": "string",
   "predictionConfiguration": { 
      "businessNameGeneration": { 
         "enabled": boolean
      }
   },
   "typeIdentifier": "string",
   "typeRevision": "string"
}

URI Request Parameters

The request uses the following URI parameters.

domainIdentifier

Amazon DataZone domain where the asset is created.

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

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

description

Asset description.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 2048.

Required: No

externalIdentifier

The external identifier of the asset.

Type: String

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

Required: No

formsInput

Metadata forms attached to the asset.

Type: Array of FormInput objects

Array Members: Minimum number of 0 items. Maximum number of 10 items.

Required: No

glossaryTerms

Glossary terms attached to the asset.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 20 items.

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

Required: No

name

Asset name.

Type: String

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

Required: Yes

owningProjectIdentifier

The unique identifier of the project that owns this asset.

Type: String

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

Required: Yes

predictionConfiguration

The configuration of the automatically generated business-friendly metadata for the asset.

Type: PredictionConfiguration object

Required: No

typeIdentifier

The unique identifier of this asset's type.

Type: String

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

Pattern: ^(?!\.)[\w\.]*\w$

Required: Yes

typeRevision

The revision of this asset's type.

Type: String

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

Required: No

Response Syntax


HTTP/1.1 201
Content-type: application/json

{
   "createdAt": number,
   "createdBy": "string",
   "description": "string",
   "domainId": "string",
   "externalIdentifier": "string",
   "firstRevisionCreatedAt": number,
   "firstRevisionCreatedBy": "string",
   "formsOutput": [ 
      { 
         "content": "string",
         "formName": "string",
         "typeName": "string",
         "typeRevision": "string"
      }
   ],
   "glossaryTerms": [ "string" ],
   "id": "string",
   "latestTimeSeriesDataPointFormsOutput": [ 
      { 
         "contentSummary": "string",
         "formName": "string",
         "id": "string",
         "timestamp": number,
         "typeIdentifier": "string",
         "typeRevision": "string"
      }
   ],
   "listing": { 
      "listingId": "string",
      "listingStatus": "string"
   },
   "name": "string",
   "owningProjectId": "string",
   "predictionConfiguration": { 
      "businessNameGeneration": { 
         "enabled": boolean
      }
   },
   "readOnlyFormsOutput": [ 
      { 
         "content": "string",
         "formName": "string",
         "typeName": "string",
         "typeRevision": "string"
      }
   ],
   "revision": "string",
   "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.

createdAt

The timestamp of when the asset was created.

Type: Timestamp

createdBy

The Amazon DataZone user that created this asset in the catalog.

Type: String

description

The description of the created asset.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 2048.

domainId

The ID of the Amazon DataZone domain in which the asset was created.

Type: String

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

externalIdentifier

The external identifier of the asset.

Type: String

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

firstRevisionCreatedAt

The timestamp of when the first revision of the asset took place.

Type: Timestamp

firstRevisionCreatedBy

The Amazon DataZone user that made the first revision of the asset.

Type: String

formsOutput

The metadata forms that are attached to the created asset.

Type: Array of FormOutput objects

Array Members: Minimum number of 0 items. Maximum number of 10 items.

glossaryTerms

The glossary terms that are attached to the created asset.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 20 items.

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

id

The unique identifier of the created asset.

Type: String

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

latestTimeSeriesDataPointFormsOutput

The latest data point that was imported into the time series form for the asset.

Type: Array of TimeSeriesDataPointSummaryFormOutput objects

listing

The details of an asset published in an Amazon DataZone catalog.

Type: AssetListingDetails object

name

The name of the created asset.

Type: String

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

owningProjectId

The ID of the Amazon DataZone project that owns the created asset.

Type: String

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

predictionConfiguration

The configuration of the automatically generated business-friendly metadata for the asset.

Type: PredictionConfiguration object

readOnlyFormsOutput

The read-only metadata forms that are attached to the created asset.

Type: Array of FormOutput objects

Array Members: Minimum number of 0 items. Maximum number of 10 items.

revision

The revision of the asset.

Type: String

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

typeIdentifier

The identifier of the created asset type.

Type: String

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

Pattern: ^(?!\.)[\w\.]*\w$

typeRevision

The revision type of 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

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