UpdateProject
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.
Note
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.
Request Syntax
{
"ProjectDescription": "string",
"ProjectName": "string",
"ServiceCatalogProvisioningUpdateDetails": {
"ProvisioningArtifactId": "string",
"ProvisioningParameters": [
{
"Key": "string",
"Value": "string"
}
]
},
"Tags": [
{
"Key": "string",
"Value": "string"
}
]
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- ProjectDescription
-
The description for the project.
Type: String
Length Constraints: Maximum length of 1024.
Pattern:
[\p{L}\p{M}\p{Z}\p{S}\p{N}\p{P}]*Required: No
- ProjectName
-
The name of the project.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 32.
Pattern:
^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,31}Required: Yes
- ServiceCatalogProvisioningUpdateDetails
-
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 AWS Service Catalog.
Type: ServiceCatalogProvisioningUpdateDetails object
Required: No
- Tags
-
An array of key-value pairs. You can use tags to categorize your AWS resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging AWS Resources. In addition, the project must have tag update constraints set in order to include this parameter in the request. For more information, see AWS Service Catalog Tag Update Constraints.
Type: Array of Tag objects
Array Members: Minimum number of 0 items. Maximum number of 50 items.
Required: No
Response Syntax
{
"ProjectArn": "string"
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- ProjectArn
-
The Amazon Resource Name (ARN) of the project.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern:
^arn:aws(-cn|-us-gov|-iso-f)?:sagemaker:[a-z0-9\-]{9,16}:[0-9]{12}:project/[\S]{1,2048}$
Errors
For information about the errors that are common to all actions, see Common Errors.
- ConflictException
-
There was a conflict when you attempted to modify a SageMaker entity such as an
ExperimentorArtifact.HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
