- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
GetFormTypeCommand
Gets a metadata form type in Amazon DataZone.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { DataZoneClient, GetFormTypeCommand } from "@aws-sdk/client-datazone"; // ES Modules import
// const { DataZoneClient, GetFormTypeCommand } = require("@aws-sdk/client-datazone"); // CommonJS import
const client = new DataZoneClient(config);
const input = { // GetFormTypeInput
domainIdentifier: "STRING_VALUE", // required
formTypeIdentifier: "STRING_VALUE", // required
revision: "STRING_VALUE",
};
const command = new GetFormTypeCommand(input);
const response = await client.send(command);
// { // GetFormTypeOutput
// domainId: "STRING_VALUE", // required
// name: "STRING_VALUE", // required
// revision: "STRING_VALUE", // required
// model: { // Model Union: only one key present
// smithy: "STRING_VALUE",
// },
// owningProjectId: "STRING_VALUE",
// originDomainId: "STRING_VALUE",
// originProjectId: "STRING_VALUE",
// status: "ENABLED" || "DISABLED",
// createdAt: new Date("TIMESTAMP"),
// createdBy: "STRING_VALUE",
// description: "STRING_VALUE",
// imports: [ // ImportList
// { // Import
// name: "STRING_VALUE", // required
// revision: "STRING_VALUE", // required
// },
// ],
// };
GetFormTypeCommand Input
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
domainIdentifier Required | string | undefined | The ID of the Amazon DataZone domain in which this metadata form type exists. |
formTypeIdentifier Required | string | undefined | The ID of the metadata form type. |
revision | string | undefined | The revision of this metadata form type. |
GetFormTypeCommand Output
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
domainId Required | string | undefined | The ID of the Amazon DataZone domain in which this metadata form type exists. |
model Required | Model | undefined | The model of the metadata form type. |
name Required | string | undefined | The name of the metadata form type. |
revision Required | string | undefined | The revision of the metadata form type. |
createdAt | Date | undefined | The timestamp of when this metadata form type was created. |
createdBy | string | undefined | The Amazon DataZone user who created this metadata form type. |
description | string | undefined | The description of the metadata form type. |
imports | Import[] | undefined | The imports of the metadata form type. |
originDomainId | string | undefined | The ID of the Amazon DataZone domain in which the metadata form type was originally created. |
originProjectId | string | undefined | The ID of the project in which this metadata form type was originally created. |
owningProjectId | string | undefined | The ID of the project that owns this metadata form type. |
status | FormTypeStatus | undefined | The status of the metadata form type. |
Throws
Name | Fault | Details |
---|
Name | Fault | Details |
---|---|---|
AccessDeniedException | client | You do not have sufficient access to perform this action. |
InternalServerException | server | The request has failed because of an unknown error, exception or failure. |
ResourceNotFoundException | client | The specified resource cannot be found. |
ThrottlingException | client | The request was denied due to request throttling. |
ValidationException | client | The input fails to satisfy the constraints specified by the Amazon Web Services service. |
UnauthorizedException | client | You do not have permission to perform this action. |
DataZoneServiceException | Base exception class for all service exceptions from DataZone service. |