- 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.
GetEnvironmentBlueprintCommand
Gets an Amazon DataZone blueprint.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { DataZoneClient, GetEnvironmentBlueprintCommand } from "@aws-sdk/client-datazone"; // ES Modules import
// const { DataZoneClient, GetEnvironmentBlueprintCommand } = require("@aws-sdk/client-datazone"); // CommonJS import
const client = new DataZoneClient(config);
const input = { // GetEnvironmentBlueprintInput
domainIdentifier: "STRING_VALUE", // required
identifier: "STRING_VALUE", // required
};
const command = new GetEnvironmentBlueprintCommand(input);
const response = await client.send(command);
// { // GetEnvironmentBlueprintOutput
// id: "STRING_VALUE", // required
// name: "STRING_VALUE", // required
// description: "STRING_VALUE",
// provider: "STRING_VALUE", // required
// provisioningProperties: { // ProvisioningProperties Union: only one key present
// cloudFormation: { // CloudFormationProperties
// templateUrl: "STRING_VALUE", // required
// },
// },
// deploymentProperties: { // DeploymentProperties
// startTimeoutMinutes: Number("int"),
// endTimeoutMinutes: Number("int"),
// },
// userParameters: [ // CustomParameterList
// { // CustomParameter
// keyName: "STRING_VALUE", // required
// description: "STRING_VALUE",
// fieldType: "STRING_VALUE", // required
// defaultValue: "STRING_VALUE",
// isEditable: true || false,
// isOptional: true || false,
// },
// ],
// glossaryTerms: [ // GlossaryTerms
// "STRING_VALUE",
// ],
// createdAt: new Date("TIMESTAMP"),
// updatedAt: new Date("TIMESTAMP"),
// };
GetEnvironmentBlueprintCommand Input
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
domainIdentifier Required | string | undefined | The identifier of the domain in which this blueprint exists. |
identifier Required | string | undefined | The ID of this Amazon DataZone blueprint. |
GetEnvironmentBlueprintCommand Output
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
id Required | string | undefined | The ID of this Amazon DataZone blueprint. |
name Required | string | undefined | The name of this Amazon DataZone blueprint. |
provider Required | string | undefined | The provider of this Amazon DataZone blueprint. |
provisioningProperties Required | ProvisioningProperties | undefined | The provisioning properties of this Amazon DataZone blueprint. |
createdAt | Date | undefined | A timestamp of when this blueprint was created. |
deploymentProperties | DeploymentProperties | undefined | The deployment properties of this Amazon DataZone blueprint. |
description | string | undefined | The description of this Amazon DataZone blueprint. |
glossaryTerms | string[] | undefined | The glossary terms attached to this Amazon DataZone blueprint. |
updatedAt | Date | undefined | The timestamp of when this blueprint was updated. |
userParameters | CustomParameter[] | undefined | The user parameters of this blueprint. |
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. |