UpdateProjectCommand

Suggest an Edit

Updates the specified project in Amazon DataZone.

Example Syntax

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

import { DataZoneClient, UpdateProjectCommand } from "@aws-sdk/client-datazone"; // ES Modules import
// const { DataZoneClient, UpdateProjectCommand } = require("@aws-sdk/client-datazone"); // CommonJS import
const client = new DataZoneClient(config);
const input = { // UpdateProjectInput
  domainIdentifier: "STRING_VALUE", // required
  identifier: "STRING_VALUE", // required
  name: "STRING_VALUE",
  description: "STRING_VALUE",
  glossaryTerms: [ // GlossaryTerms
    "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
        },
      ],
    },
  },
  userParameters: [ // EnvironmentConfigurationUserParametersList
    { // EnvironmentConfigurationUserParameter
      environmentId: "STRING_VALUE",
      environmentConfigurationName: "STRING_VALUE",
      environmentParameters: [ // EnvironmentParametersList
        { // EnvironmentParameter
          name: "STRING_VALUE",
          value: "STRING_VALUE",
        },
      ],
    },
  ],
  projectProfileVersion: "STRING_VALUE",
};
const command = new UpdateProjectCommand(input);
const response = await client.send(command);
// { // UpdateProjectOutput
//   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
//         },
//       ],
//     },
//   },
// };

UpdateProjectCommand Input

See UpdateProjectCommandInput for more details

Parameter
Type
Description
domainIdentifier
Required
string | undefined

The ID of the Amazon DataZone domain where a project is being updated.

identifier
Required
string | undefined

The identifier of the project that is to be updated.

description
string | undefined

The description to be updated as part of the UpdateProject action.

environmentDeploymentDetails
EnvironmentDeploymentDetails | undefined

The environment deployment details of the project.

glossaryTerms
string[] | undefined

The glossary terms to be updated as part of the UpdateProject action.

name
string | undefined

The name to be updated as part of the UpdateProject action.

projectProfileVersion
string | undefined

The project profile version to which the project should be updated. You can only specify the following string for this parameter: latest.

userParameters
EnvironmentConfigurationUserParameter[] | undefined

The user parameters of the project.

UpdateProjectCommand Output

See UpdateProjectCommandOutput 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 a project is updated.

id
Required
string | undefined

The identifier of the project that is to be updated.

name
Required
string | undefined

The name of the project that is to be updated.

createdAt
Date | undefined

The timestamp of when the project was created.

description
string | undefined

The description of the project that is to be updated.

domainUnitId
string | undefined

The ID of the domain unit.

environmentDeploymentDetails
EnvironmentDeploymentDetails | undefined

The environment deployment details of the project.

failureReasons
ProjectDeletionError[] | undefined

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

glossaryTerms
string[] | undefined

The glossary terms of the project that are to be updated.

lastUpdatedAt
Date | undefined

The timestamp of when the project was last updated.

projectProfileId
string | undefined

The ID of the project profile.

projectStatus
ProjectStatus | undefined

The status of the project.

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.