CreateEnvironmentProfileCommand

Creates an Amazon DataZone environment profile.

Example Syntax

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

import { DataZoneClient, CreateEnvironmentProfileCommand } from "@aws-sdk/client-datazone"; // ES Modules import
// const { DataZoneClient, CreateEnvironmentProfileCommand } = require("@aws-sdk/client-datazone"); // CommonJS import
const client = new DataZoneClient(config);
const input = { // CreateEnvironmentProfileInput
  domainIdentifier: "STRING_VALUE", // required
  name: "STRING_VALUE", // required
  description: "STRING_VALUE",
  environmentBlueprintIdentifier: "STRING_VALUE", // required
  projectIdentifier: "STRING_VALUE", // required
  userParameters: [ // EnvironmentParametersList
    { // EnvironmentParameter
      name: "STRING_VALUE",
      value: "STRING_VALUE",
    },
  ],
  awsAccountId: "STRING_VALUE",
  awsAccountRegion: "STRING_VALUE",
};
const command = new CreateEnvironmentProfileCommand(input);
const response = await client.send(command);
// { // CreateEnvironmentProfileOutput
//   id: "STRING_VALUE", // required
//   domainId: "STRING_VALUE", // required
//   awsAccountId: "STRING_VALUE",
//   awsAccountRegion: "STRING_VALUE",
//   createdBy: "STRING_VALUE", // required
//   createdAt: new Date("TIMESTAMP"),
//   updatedAt: new Date("TIMESTAMP"),
//   name: "STRING_VALUE", // required
//   description: "STRING_VALUE",
//   environmentBlueprintId: "STRING_VALUE", // required
//   projectId: "STRING_VALUE",
//   userParameters: [ // CustomParameterList
//     { // CustomParameter
//       keyName: "STRING_VALUE", // required
//       description: "STRING_VALUE",
//       fieldType: "STRING_VALUE", // required
//       defaultValue: "STRING_VALUE",
//       isEditable: true || false,
//       isOptional: true || false,
//     },
//   ],
// };

CreateEnvironmentProfileCommand Input

Parameter
Type
Description
domainIdentifier
Required
string | undefined

The ID of the Amazon DataZone domain in which this environment profile is created.

environmentBlueprintIdentifier
Required
string | undefined

The ID of the blueprint with which this environment profile is created.

name
Required
string | undefined

The name of this Amazon DataZone environment profile.

projectIdentifier
Required
string | undefined

The identifier of the project in which to create the environment profile.

awsAccountId
string | undefined

The Amazon Web Services account in which the Amazon DataZone environment is created.

awsAccountRegion
string | undefined

The Amazon Web Services region in which this environment profile is created.

description
string | undefined

The description of this Amazon DataZone environment profile.

userParameters
EnvironmentParameter[] | undefined

The user parameters of this Amazon DataZone environment profile.

CreateEnvironmentProfileCommand Output

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

The Amazon DataZone user who created this environment profile.

domainId
Required
string | undefined

The ID of the Amazon DataZone domain in which this environment profile is created.

environmentBlueprintId
Required
string | undefined

The ID of the blueprint with which this environment profile is created.

id
Required
string | undefined

The ID of this Amazon DataZone environment profile.

name
Required
string | undefined

The name of this Amazon DataZone environment profile.

awsAccountId
string | undefined

The Amazon Web Services account ID in which this Amazon DataZone environment profile is created.

awsAccountRegion
string | undefined

The Amazon Web Services region in which this Amazon DataZone environment profile is created.

createdAt
Date | undefined

The timestamp of when this environment profile was created.

description
string | undefined

The description of this Amazon DataZone environment profile.

projectId
string | undefined

The ID of the Amazon DataZone project in which this environment profile is created.

updatedAt
Date | undefined

The timestamp of when this environment profile was updated.

userParameters
CustomParameter[] | undefined

The user parameters of this Amazon DataZone environment profile.

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.

ServiceQuotaExceededException
client

The request has exceeded the specified service quota.

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.