Create Asset

datazone_create_asset

R Documentation

Creates an asset in Amazon DataZone catalog

Description

Creates an asset in Amazon DataZone catalog.

Before creating assets, make sure that the following requirements are met:

• --domain-identifier must refer to an existing domain.

• --owning-project-identifier must be a valid project within the domain.

• Asset type must be created beforehand using create-asset-type, or be a supported system-defined type. For more information, see create-asset-type.

• --type-revision (if used) must match a valid revision of the asset type.

• formsInput is required when it is associated as required in the asset-type. For more information, see create-form-type.

• Form content must include all required fields as per the form schema (e.g., bucketArn).

You must invoke the following pre-requisite commands before invoking this API:

• create_form_type

• create_asset_type

Usage

datazone_create_asset(name, domainIdentifier, externalIdentifier,
  typeIdentifier, typeRevision, description, glossaryTerms, formsInput,
  owningProjectIdentifier, predictionConfiguration, clientToken)

Arguments

name	[required] Asset name.
domainIdentifier	[required] Amazon DataZone domain where the asset is created.
externalIdentifier	The external identifier of the asset. If the value for the externalIdentifier parameter is specified, it must be a unique value.
typeIdentifier	[required] The unique identifier of this asset's type.
typeRevision	The revision of this asset's type.
description	Asset description.
glossaryTerms	Glossary terms attached to the asset.
formsInput	Metadata forms attached to the asset.
owningProjectIdentifier	[required] The unique identifier of the project that owns this asset.
predictionConfiguration	The configuration of the automatically generated business-friendly metadata for the asset.
clientToken	A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.

Value

A list with the following syntax:

list(
  id = "string",
  name = "string",
  typeIdentifier = "string",
  typeRevision = "string",
  externalIdentifier = "string",
  revision = "string",
  description = "string",
  createdAt = as.POSIXct(
    "2015-01-01"
  ),
  createdBy = "string",
  firstRevisionCreatedAt = as.POSIXct(
    "2015-01-01"
  ),
  firstRevisionCreatedBy = "string",
  glossaryTerms = list(
    "string"
  ),
  governedGlossaryTerms = list(
    "string"
  ),
  owningProjectId = "string",
  domainId = "string",
  listing = list(
    listingId = "string",
    listingStatus = "CREATING"|"ACTIVE"|"INACTIVE"
  ),
  formsOutput = list(
    list(
      formName = "string",
      typeName = "string",
      typeRevision = "string",
      content = "string"
    )
  ),
  readOnlyFormsOutput = list(
    list(
      formName = "string",
      typeName = "string",
      typeRevision = "string",
      content = "string"
    )
  ),
  latestTimeSeriesDataPointFormsOutput = list(
    list(
      formName = "string",
      typeIdentifier = "string",
      typeRevision = "string",
      timestamp = as.POSIXct(
        "2015-01-01"
      ),
      contentSummary = "string",
      id = "string"
    )
  ),
  predictionConfiguration = list(
    businessNameGeneration = list(
      enabled = TRUE|FALSE
    )
  )
)

Request syntax

svc$create_asset(
  name = "string",
  domainIdentifier = "string",
  externalIdentifier = "string",
  typeIdentifier = "string",
  typeRevision = "string",
  description = "string",
  glossaryTerms = list(
    "string"
  ),
  formsInput = list(
    list(
      formName = "string",
      typeIdentifier = "string",
      typeRevision = "string",
      content = "string"
    )
  ),
  owningProjectIdentifier = "string",
  predictionConfiguration = list(
    businessNameGeneration = list(
      enabled = TRUE|FALSE
    )
  ),
  clientToken = "string"
)