GetEnvironmentBlueprintConfigurationCommand

Suggest an Edit

Gets the blueprint configuration in Amazon DataZone.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { DataZoneClient, GetEnvironmentBlueprintConfigurationCommand } from "@aws-sdk/client-datazone"; // ES Modules import
// const { DataZoneClient, GetEnvironmentBlueprintConfigurationCommand } = require("@aws-sdk/client-datazone"); // CommonJS import
const client = new DataZoneClient(config);
const input = { // GetEnvironmentBlueprintConfigurationInput
  domainIdentifier: "STRING_VALUE", // required
  environmentBlueprintIdentifier: "STRING_VALUE", // required
};
const command = new GetEnvironmentBlueprintConfigurationCommand(input);
const response = await client.send(command);
// { // GetEnvironmentBlueprintConfigurationOutput
//   domainId: "STRING_VALUE", // required
//   environmentBlueprintId: "STRING_VALUE", // required
//   provisioningRoleArn: "STRING_VALUE",
//   environmentRolePermissionBoundary: "STRING_VALUE",
//   manageAccessRoleArn: "STRING_VALUE",
//   enabledRegions: [ // EnabledRegionList
//     "STRING_VALUE",
//   ],
//   regionalParameters: { // RegionalParameterMap
//     "<keys>": { // RegionalParameter
//       "<keys>": "STRING_VALUE",
//     },
//   },
//   createdAt: new Date("TIMESTAMP"),
//   updatedAt: new Date("TIMESTAMP"),
//   provisioningConfigurations: [ // ProvisioningConfigurationList
//     { // ProvisioningConfiguration Union: only one key present
//       lakeFormationConfiguration: { // LakeFormationConfiguration
//         locationRegistrationRole: "STRING_VALUE",
//         locationRegistrationExcludeS3Locations: [ // S3LocationList
//           "STRING_VALUE",
//         ],
//       },
//     },
//   ],
// };

GetEnvironmentBlueprintConfigurationCommand Input

See GetEnvironmentBlueprintConfigurationCommandInput for more details

Parameter
Type
Description
domainIdentifier
Required
string | undefined

The ID of the Amazon DataZone domain where this blueprint exists.

environmentBlueprintIdentifier
Required
string | undefined

He ID of the blueprint.

GetEnvironmentBlueprintConfigurationCommand Output

See GetEnvironmentBlueprintConfigurationCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
domainId
Required
string | undefined

The ID of the Amazon DataZone domain where this blueprint exists.

environmentBlueprintId
Required
string | undefined

The ID of the blueprint.

createdAt
Date | undefined

The timestamp of when this blueprint was created.

enabledRegions
string[] | undefined

The Amazon Web Services regions in which this blueprint is enabled.

environmentRolePermissionBoundary
string | undefined

The environment role permissions boundary.

manageAccessRoleArn
string | undefined

The ARN of the manage access role with which this blueprint is created.

provisioningConfigurations
ProvisioningConfiguration[] | undefined

The provisioning configuration of a blueprint.

provisioningRoleArn
string | undefined

The ARN of the provisioning role with which this blueprint is created.

regionalParameters
Record<string, Record<string, string> | undefined

The regional parameters of the blueprint.

updatedAt
Date | undefined

The timestamp of when this blueprint was upated.

Throws

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.

ValidationException
client

The input fails to satisfy the constraints specified by the Amazon Web Services service.

ThrottlingException
client

The request was denied due to request throttling.

UnauthorizedException
client

You do not have permission to perform this action.

DataZoneServiceException
Base exception class for all service exceptions from DataZone service.