Skip to content

Get Asset

datazone_get_asset R Documentation

Gets an Amazon DataZone asset

Description

Gets an Amazon DataZone asset.

An asset is the fundamental building block in Amazon DataZone, representing any data resource that needs to be cataloged and managed. It can take many forms, from Amazon S3 buckets and database tables to dashboards and machine learning models. Each asset contains comprehensive metadata about the resource, including its location, schema, ownership, and lineage information. Assets are essential for organizing and managing data resources across an organization, making them discoverable and usable while maintaining proper governance.

Before using the Amazon DataZone GetAsset command, ensure the following prerequisites are met:

  • Domain identifier must exist and be valid

  • Asset identifier must exist

  • User must have the required permissions to perform the action

Usage

datazone_get_asset(domainIdentifier, identifier, revision)

Arguments

domainIdentifier

[required] The ID of the Amazon DataZone domain to which the asset belongs.

identifier

[required] The ID of the Amazon DataZone asset.

This parameter supports either the value of assetId or externalIdentifier as input. If you are passing the value of externalIdentifier, you must prefix this value with ⁠externalIdentifer%2F⁠.

revision

The revision of the Amazon DataZone asset.

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"
    )
  )
)

Request syntax

svc$get_asset(
  domainIdentifier = "string",
  identifier = "string",
  revision = "string"
)