SageMaker / Client / update_project

update_project

SageMaker.Client.update_project(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.update_project(
    ProjectName='string',
    ProjectDescription='string',
    ServiceCatalogProvisioningUpdateDetails={
        'ProvisioningArtifactId': 'string',
        'ProvisioningParameters': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ]
    },
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)

Parameters:

• ProjectName (string) –

  [REQUIRED]

  The name of the project.

• ProjectDescription (string) – The description for the project.

• ServiceCatalogProvisioningUpdateDetails (dict) –

  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.

  • ProvisioningArtifactId (string) –

    The ID of the provisioning artifact.

  • ProvisioningParameters (list) –

    A list of key value pairs that you specify when you provision a product.

    • (dict) –

      A key value pair used when you provision a project as a service catalog product. For information, see What is Amazon Web Services Service Catalog.

      • Key (string) –

        The key that identifies a provisioning parameter.

      • Value (string) –

        The value of the provisioning parameter.

• Tags (list) –

  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.

  • (dict) –

    A tag object that consists of a key and an optional value, used to manage metadata for SageMaker Amazon Web Services resources.

    You can add tags to notebook instances, training jobs, hyperparameter tuning jobs, batch transform jobs, models, labeling jobs, work teams, endpoint configurations, and endpoints. For more information on adding tags to SageMaker resources, see AddTags.

    For more information on adding metadata to your Amazon Web Services resources with tagging, see Tagging Amazon Web Services resources. For advice on best practices for managing Amazon Web Services resources with tagging, see Tagging Best Practices: Implement an Effective Amazon Web Services Resource Tagging Strategy.

    • Key (string) – [REQUIRED]

      The tag key. Tag keys must be unique per resource.

    • Value (string) – [REQUIRED]

      The tag value.

Return type:

dict

Returns:

Response Syntax

{
    'ProjectArn': 'string'
}

Response Structure

• (dict) –

  • ProjectArn (string) –

    The Amazon Resource Name (ARN) of the project.

Exceptions

• SageMaker.Client.exceptions.ConflictException