GetProjectCommand

Suggest an Edit

Gets a project in Amazon DataZone.

Example Syntax

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

import { DataZoneClient, GetProjectCommand } from "@aws-sdk/client-datazone"; // ES Modules import
// const { DataZoneClient, GetProjectCommand } = require("@aws-sdk/client-datazone"); // CommonJS import
const client = new DataZoneClient(config);
const input = { // GetProjectInput
  domainIdentifier: "STRING_VALUE", // required
  identifier: "STRING_VALUE", // required
};
const command = new GetProjectCommand(input);
const response = await client.send(command);
// { // GetProjectOutput
//   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
//         },
//       ],
//     },
//   },
// };

GetProjectCommand Input

See GetProjectCommandInput for more details

Parameter
Type
Description
domainIdentifier
Required
string | undefined

The ID of the Amazon DataZone domain in which the project exists.

identifier
Required
string | undefined

The ID of the project.

GetProjectCommand Output

See GetProjectCommandOutput 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 ID of the Amazon DataZone domain in which the project exists.

id
Required
string | undefined

>The ID of the 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 status of a project.

failureReasons
ProjectDeletionError[] | undefined

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

glossaryTerms
string[] | undefined

The business 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 ID of the project profile of a project.

projectStatus
ProjectStatus | undefined

The status of the project.

userParameters
EnvironmentConfigurationUserParameter[] | undefined

The user parameters of a project.

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.

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.