UpdateProjectCommand

Updates a machine learning (ML) project that is created from a template that sets up an ML pipeline from training to deploying an approved model.

You must not update a project that is in use. If you update the ServiceCatalogProvisioningUpdateDetails of a project that is active or being created, or updated, you may lose resources already created by the project.

Example Syntax

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

import { SageMakerClient, UpdateProjectCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import
// const { SageMakerClient, UpdateProjectCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import
const client = new SageMakerClient(config);
const input = { // UpdateProjectInput
  ProjectName: "STRING_VALUE", // required
  ProjectDescription: "STRING_VALUE",
  ServiceCatalogProvisioningUpdateDetails: { // ServiceCatalogProvisioningUpdateDetails
    ProvisioningArtifactId: "STRING_VALUE",
    ProvisioningParameters: [ // ProvisioningParameters
      { // ProvisioningParameter
        Key: "STRING_VALUE",
        Value: "STRING_VALUE",
      },
    ],
  },
  Tags: [ // TagList
    { // Tag
      Key: "STRING_VALUE", // required
      Value: "STRING_VALUE", // required
    },
  ],
};
const command = new UpdateProjectCommand(input);
const response = await client.send(command);
// { // UpdateProjectOutput
//   ProjectArn: "STRING_VALUE", // required
// };

UpdateProjectCommand Input

See UpdateProjectCommandInput for more details

Parameter
Type
Description
ProjectName
Required
string | undefined

The name of the project.

ProjectDescription
string | undefined

The description for the project.

ServiceCatalogProvisioningUpdateDetails
ServiceCatalogProvisioningUpdateDetails | undefined

The product ID and provisioning artifact ID to provision a service catalog. The provisioning artifact ID will default to the latest provisioning artifact ID of the product, if you don't provide the provisioning artifact ID. For more information, see What is Amazon Web Services Service Catalog .

Tags
Tag[] | undefined

An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources . In addition, the project must have tag update constraints set in order to include this parameter in the request. For more information, see Amazon Web Services Service Catalog Tag Update Constraints .

UpdateProjectCommand Output

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

The Amazon Resource Name (ARN) of the project.

Throws

Name
Fault
Details
ConflictException
client

There was a conflict when you attempted to modify a SageMaker entity such as an Experiment or Artifact.

SageMakerServiceException
Base exception class for all service exceptions from SageMaker service.