CreateProjectCommand

Suggest an Edit

Creates an Amazon DataZone project.

Example Syntax

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

import { DataZoneClient, CreateProjectCommand } from "@aws-sdk/client-datazone"; // ES Modules import
// const { DataZoneClient, CreateProjectCommand } = require("@aws-sdk/client-datazone"); // CommonJS import
const client = new DataZoneClient(config);
const input = { // CreateProjectInput
  domainIdentifier: "STRING_VALUE", // required
  name: "STRING_VALUE", // required
  description: "STRING_VALUE",
  glossaryTerms: [ // GlossaryTerms
    "STRING_VALUE",
  ],
  domainUnitId: "STRING_VALUE",
  projectProfileId: "STRING_VALUE",
  userParameters: [ // EnvironmentConfigurationUserParametersList
    { // EnvironmentConfigurationUserParameter
      environmentId: "STRING_VALUE",
      environmentConfigurationName: "STRING_VALUE",
      environmentParameters: [ // EnvironmentParametersList
        { // EnvironmentParameter
          name: "STRING_VALUE",
          value: "STRING_VALUE",
        },
      ],
    },
  ],
};
const command = new CreateProjectCommand(input);
const response = await client.send(command);
// { // CreateProjectOutput
//   domainId: "STRING_VALUE", // required
//   id: "STRING_VALUE", // required
//   name: "STRING_VALUE", // required
//   description: "STRING_VALUE",
//   projectStatus: "ACTIVE" || "DELETING" || "DELETE_FAILED" || "UPDATING" || "UPDATE_FAILED",
//   failureReasons: [ // FailureReasons
//     { // ProjectDeletionError
//       code: "STRING_VALUE",
//       message: "STRING_VALUE",
//     },
//   ],
//   createdBy: "STRING_VALUE", // required
//   createdAt: new Date("TIMESTAMP"),
//   lastUpdatedAt: new Date("TIMESTAMP"),
//   glossaryTerms: [ // GlossaryTerms
//     "STRING_VALUE",
//   ],
//   domainUnitId: "STRING_VALUE",
//   projectProfileId: "STRING_VALUE",
//   userParameters: [ // EnvironmentConfigurationUserParametersList
//     { // EnvironmentConfigurationUserParameter
//       environmentId: "STRING_VALUE",
//       environmentConfigurationName: "STRING_VALUE",
//       environmentParameters: [ // EnvironmentParametersList
//         { // EnvironmentParameter
//           name: "STRING_VALUE",
//           value: "STRING_VALUE",
//         },
//       ],
//     },
//   ],
//   environmentDeploymentDetails: { // EnvironmentDeploymentDetails
//     overallDeploymentStatus: "PENDING_DEPLOYMENT" || "IN_PROGRESS" || "SUCCESSFUL" || "FAILED_VALIDATION" || "FAILED_DEPLOYMENT",
//     environmentFailureReasons: { // EnvironmentFailureReasons
//       "<keys>": [ // EnvironmentFailureReasonsList
//         { // EnvironmentError
//           code: "STRING_VALUE",
//           message: "STRING_VALUE", // required
//         },
//       ],
//     },
//   },
// };

CreateProjectCommand Input

See CreateProjectCommandInput for more details

Parameter
Type
Description
domainIdentifier
Required
string | undefined

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

name
Required
string | undefined

The name of the Amazon DataZone project.

description
string | undefined

The description of the Amazon DataZone project.

domainUnitId
string | undefined

The ID of the domain unit. This parameter is not required and if it is not specified, then the project is created at the root domain unit level.

glossaryTerms
string[] | undefined

The glossary terms that can be used in this Amazon DataZone project.

projectProfileId
string | undefined

The ID of the project profile.

userParameters
EnvironmentConfigurationUserParameter[] | undefined

The user parameters of the project.

CreateProjectCommand Output

See CreateProjectCommandOutput for details

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

The Amazon DataZone user who created the project.

domainId
Required
string | undefined

The identifier of the Amazon DataZone domain in which the project was created.

id
Required
string | undefined

The ID of the Amazon DataZone project.

name
Required
string | undefined

The name of the project.

createdAt
Date | undefined

The timestamp of when the project was created.

description
string | undefined

The description of the project.

domainUnitId
string | undefined

The ID of the domain unit.

environmentDeploymentDetails
EnvironmentDeploymentDetails | undefined

The environment deployment details.

failureReasons
ProjectDeletionError[] | undefined

Specifies the error message that is returned if the operation cannot be successfully completed.

glossaryTerms
string[] | undefined

The glossary terms that can be used in the project.

lastUpdatedAt
Date | undefined

The timestamp of when the project was last updated.

projectProfileId
string | undefined

The project profile ID.

projectStatus
ProjectStatus | undefined

The status of the Amazon DataZone project that was created.

userParameters
EnvironmentConfigurationUserParameter[] | undefined

The user parameters of the project.

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.