PutEnvironmentBlueprintConfigurationCommand

Suggest an Edit

Writes the configuration for the specified environment blueprint in Amazon DataZone.

Example Syntax

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

import { DataZoneClient, PutEnvironmentBlueprintConfigurationCommand } from "@aws-sdk/client-datazone"; // ES Modules import
// const { DataZoneClient, PutEnvironmentBlueprintConfigurationCommand } = require("@aws-sdk/client-datazone"); // CommonJS import
const client = new DataZoneClient(config);
const input = { // PutEnvironmentBlueprintConfigurationInput
  domainIdentifier: "STRING_VALUE", // required
  environmentBlueprintIdentifier: "STRING_VALUE", // required
  provisioningRoleArn: "STRING_VALUE",
  manageAccessRoleArn: "STRING_VALUE",
  environmentRolePermissionBoundary: "STRING_VALUE",
  enabledRegions: [ // EnabledRegionList // required
    "STRING_VALUE",
  ],
  regionalParameters: { // RegionalParameterMap
    "<keys>": { // RegionalParameter
      "<keys>": "STRING_VALUE",
    },
  },
  provisioningConfigurations: [ // ProvisioningConfigurationList
    { // ProvisioningConfiguration Union: only one key present
      lakeFormationConfiguration: { // LakeFormationConfiguration
        locationRegistrationRole: "STRING_VALUE",
        locationRegistrationExcludeS3Locations: [ // S3LocationList
          "STRING_VALUE",
        ],
      },
    },
  ],
};
const command = new PutEnvironmentBlueprintConfigurationCommand(input);
const response = await client.send(command);
// { // PutEnvironmentBlueprintConfigurationOutput
//   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",
//         ],
//       },
//     },
//   ],
// };

PutEnvironmentBlueprintConfigurationCommand Input

See PutEnvironmentBlueprintConfigurationCommandInput for more details

Parameter
Type
Description
domainIdentifier
Required
string | undefined

The identifier of the Amazon DataZone domain.

enabledRegions
Required
string[] | undefined

Specifies the enabled Amazon Web Services Regions.

environmentBlueprintIdentifier
Required
string | undefined

The identifier of the environment blueprint.

environmentRolePermissionBoundary
string | undefined

The environment role permissions boundary.

manageAccessRoleArn
string | undefined

The ARN of the manage access role.

provisioningConfigurations
ProvisioningConfiguration[] | undefined

The provisioning configuration of a blueprint.

provisioningRoleArn
string | undefined

The ARN of the provisioning role.

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

The regional parameters in the environment blueprint.

PutEnvironmentBlueprintConfigurationCommand Output

See PutEnvironmentBlueprintConfigurationCommandOutput for details

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

The identifier of the Amazon DataZone domain.

environmentBlueprintId
Required
string | undefined

The identifier of the environment blueprint.

createdAt
Date | undefined

The timestamp of when the environment blueprint was created.

enabledRegions
string[] | undefined

Specifies the enabled Amazon Web Services Regions.

environmentRolePermissionBoundary
string | undefined

The environment role permissions boundary.

manageAccessRoleArn
string | undefined

The ARN of the manage access role.

provisioningConfigurations
ProvisioningConfiguration[] | undefined

The provisioning configuration of a blueprint.

provisioningRoleArn
string | undefined

The ARN of the provisioning role.

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

The regional parameters in the environment blueprint.

updatedAt
Date | undefined

The timestamp of when the environment blueprint was updated.

Throws

Name
Fault
Details
AccessDeniedException
client

You do not have sufficient access to perform this action.

ConflictException
client

There is a conflict while performing 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.