GetDataProduct
Gets the data product.
Prerequisites:
-
The data product ID must exist.
-
The domain must be valid and accessible.
-
User must have read or discovery permissions for the data product.
Request Syntax
GET /v2/domains/domainIdentifier/data-products/identifier?revision=revision HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- domainIdentifier
-
The ID of the domain where the data product lives.
Pattern:
dzd[-_][a-zA-Z0-9_-]{1,36}Required: Yes
- identifier
-
The ID of the data product.
Pattern:
[a-zA-Z0-9_-]{1,36}Required: Yes
- revision
-
The revision of the data product.
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",
"firstRevisionCreatedAt": number,
"firstRevisionCreatedBy": "string",
"formsOutput": [
{
"content": "string",
"formName": "string",
"typeName": "string",
"typeRevision": "string"
}
],
"glossaryTerms": [ "string" ],
"id": "string",
"items": [
{
"glossaryTerms": [ "string" ],
"identifier": "string",
"itemType": "string",
"revision": "string"
}
],
"name": "string",
"owningProjectId": "string",
"revision": "string",
"status": "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 at which the data product is created.
Type: Timestamp
- createdBy
-
The user who created the data product.
Type: String
- description
-
The description of the data product.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 4096.
- domainId
-
The ID of the domain where the data product lives.
Type: String
Pattern:
dzd[-_][a-zA-Z0-9_-]{1,36} - firstRevisionCreatedAt
-
The timestamp at which the first revision of the data product is created.
Type: Timestamp
- firstRevisionCreatedBy
-
The user who created the first revision of the data product.
Type: String
- formsOutput
-
The metadata forms of the data product.
Type: Array of FormOutput objects
Array Members: Minimum number of 0 items. Maximum number of 10 items.
- glossaryTerms
-
The glossary terms of the data product.
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 ID of the data product.
Type: String
Pattern:
[a-zA-Z0-9_-]{1,36} - items
-
The data assets of the data product.
Type: Array of DataProductItem objects
Array Members: Minimum number of 1 item.
- name
-
The name of the data product.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
- owningProjectId
-
The ID of the owning project of the data product.
Type: String
Pattern:
[a-zA-Z0-9_-]{1,36} - revision
-
The revision of the data product.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
- status
-
The status of the data product.
Type: String
Valid Values:
CREATED | CREATING | CREATE_FAILED
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 GetDataProduct.
Sample Request
aws datazone get-data-product \
--domain-identifier "dzd_53ielnpxktdilj" \
--identifier "dpd9m3nqx2wkfp"
Sample Response
{
"createdAt": 1752602995.424,
"createdBy": "usr7nx82mkl",
"domainId": "dzd_53ielnpxktdilj",
"firstRevisionCreatedAt": 1752602810.307,
"firstRevisionCreatedBy": "usr7nx82mkl",
"formsOutput": [],
"id": "dpd9m3nqx2wkfp",
"name": "CustomerInsights-v2",
"owningProjectId": "prj7nx82mkl",
"revision": "2",
"status": "CREATED"
}
Example
Failure case - missing parameter:
Sample Request
aws datazone get-data-product \
--domain-identifier "dzd_53ielnpxktdilj"
Sample Response
aws: error: the following arguments are required: —identifier
Example
Failure case - resource not found:
Sample Request
aws datazone get-data-product \
--domain-identifier "dzd_53ielnpxktdilj" \
--identifier "dpd_nonexistent"
Sample Response
An error occurred (ResourceNotFoundException) when calling the GetDataProduct operation: Requested dataProduct cannot be found in domain
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
