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

GetAsset

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

Request Syntax


GET /v2/domains/domainIdentifier/assets/identifier?revision=revision HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

domainIdentifier

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

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

Required: Yes

identifier

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.

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

Required: Yes

revision

The revision of the Amazon DataZone asset.

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

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
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" ],
   "governedGlossaryTerms": [ "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",
   "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 200 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 who created the asset.

Type: String

description

The description of the Amazon DataZone asset.

Type: String

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

domainId

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

Type: String

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

externalIdentifier

The external ID of the asset.

Type: String

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

firstRevisionCreatedAt

The timestamp of when the first revision of the asset was created.

Type: Timestamp

firstRevisionCreatedBy

The Amazon DataZone user who created the first revision of the asset.

Type: String

formsOutput

The metadata forms attached to the asset.

Type: Array of FormOutput objects

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

glossaryTerms

The business 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}

governedGlossaryTerms

The restricted glossary terms attached to an asset.

Type: Array of strings

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

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

id

The ID of the 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 listing of the asset.

Type: AssetListingDetails object

name

The name of the asset.

Type: String

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

owningProjectId

The ID of the project that owns the asset.

Type: String

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

readOnlyFormsOutput

The read-only metadata forms attached to the 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 ID of the asset type.

Type: String

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

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

typeRevision

The revision of the asset type.

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

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

Examples

Example

Use the following command to retrieve an asset from Amazon DataZone:

Sample Request



aws datazone get-asset \
--domain-identifier "dzd_53ielnpxktdilj" \
--identifier "ast7k9mpq2xvn4w"

Sample Response



{
    "createdAt": 1752554243.917,
    "createdBy": "user_id_redacted",
    "domainId": "dzd_53ielnpxktdilj",
    "firstRevisionCreatedAt": 1752554243.917,
    "firstRevisionCreatedBy": "user_id_redacted",
    "formsOutput": [{
        "content": "{\"bucketArn\":\"arn:aws:s3:::analytics-data-bucket\"}",
        "formName": "CustomerAnalyticsForm",
        "typeName": "amazon.datazone.S3ObjectCollectionFormType",
        "typeRevision": "7"
    }],
    "id": "ast7k9mpq2xvn4w",
    "latestTimeSeriesDataPointFormsOutput": [],
    "name": "CustomerAnalytics2023",
    "owningProjectId": "prj9vn4wxyz8k2m",
    "readOnlyFormsOutput": [],
    "revision": "1",
    "typeIdentifier": "amazon.datazone.S3ObjectCollectionAssetType",
    "typeRevision": "13"
}

Example

When the specified asset does not exist, the command will fail:

Sample Request



aws datazone get-asset \
--domain-identifier "dzd_53ielnpxktdilj" \
--identifier "astnonexistent2m4"

Sample Response



An error occurred (ResourceNotFoundException) when calling the GetAsset operation: The given Asset doesn't exist. Try creating Asset before accessing it.

Example

When a required parameter is missing, the command will fail:

Sample Request



aws datazone get-asset \
--domain-identifier "dzd_53ielnpxktdilj"

Sample Response



aws: error: the following arguments are required: —identifier