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

GetAssetType

Gets an Amazon DataZone asset type.

Asset types define the categories and characteristics of different kinds of data assets within Amazon DataZone.. They determine what metadata fields are required, what operations are possible, and how the asset integrates with other AWS services. Asset types can range from built-in types like Amazon S3 buckets and AWS Glue tables to custom types defined for specific organizational needs. Understanding asset types is crucial for properly organizing and managing different kinds of data resources.

Prerequisites:

The asset type with identifier must exist in the domain. ResourceNotFoundException.
You must have the GetAssetType permission.
Ensure the domain-identifier value is correct and accessible.

Request Syntax


GET /v2/domains/domainIdentifier/asset-types/identifier?revision=revision HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

domainIdentifier

The ID of the Amazon DataZone domain in which the asset type exists.

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

Required: Yes

identifier

The ID of the asset type.

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

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

Required: Yes

revision

The revision of the asset type.

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",
   "formsOutput": { 
      "string" : { 
         "required": boolean,
         "typeName": "string",
         "typeRevision": "string"
      }
   },
   "name": "string",
   "originDomainId": "string",
   "originProjectId": "string",
   "owningProjectId": "string",
   "revision": "string",
   "updatedAt": number,
   "updatedBy": "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 type was created.

Type: Timestamp

createdBy

The Amazon DataZone user who created the asset type.

Type: String

description

The description of the asset type.

Type: String

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

domainId

The ID of the Amazon DataZone domain in which the asset type exists.

Type: String

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

formsOutput

The metadata forms attached to the asset type.

Type: String to FormEntryOutput object map

Map Entries: Minimum number of 0 items. Maximum number of 10 items.

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

Key Pattern: (?![0-9_])\w+$|^_\w*[a-zA-Z0-9]\w*

name

The name of the asset type.

Type: String

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

Pattern: [^\.]*.*

originDomainId

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

Type: String

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

originProjectId

The ID of the Amazon DataZone project in which the asset type was originally created.

Type: String

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

owningProjectId

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

Type: String

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

revision

The revision of the asset type.

Type: String

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

updatedAt

The timestamp of when the asset type was updated.

Type: Timestamp

updatedBy

The Amazon DataZone user that updated the asset type.

Type: String

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

This example illustrates one usage of GetAssetType.

Sample Request



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

Sample Response



{
    "createdAt": 1752576607.833,
    "createdBy": "usr7nx82mkl",
    "domainId": "dzd_53ielnpxktdilj",
    "formsOutput": {
        "AssetCommonDetailsForm": {
            "required": false,
            "typeName": "amazon.datazone.AssetCommonDetailsFormType",
            "typeRevision": "6"
        }
    },
    "name": "customerAnalyticsType",
    "owningProjectId": "prj7nx82mkl",
    "revision": "1",
    "updatedAt": 1752576607.833,
    "updatedBy": "usr7nx82mkl"
}

Example

Failure case - missing required parameter: --identifier

Sample Request



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

Sample Response



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