Amazon SageMaker Service

2025/06/19 - Amazon SageMaker Service - 4 updated api methods

Changes  This release introduces alternative support for utilizing CFN templates from S3 for SageMaker Projects.

CreateProject (updated) Link ¶
Changes (request)
{'TemplateProviders': [{'CfnTemplateProvider': {'Parameters': [{'Key': 'string',
                                                                'Value': 'string'}],
                                                'RoleARN': 'string',
                                                'TemplateName': 'string',
                                                'TemplateURL': 'string'}}]}

Creates a machine learning (ML) project that can contain one or more templates that set up an ML pipeline from training to deploying an approved model.

See also: AWS API Documentation

Request Syntax

client.create_project(
    ProjectName='string',
    ProjectDescription='string',
    ServiceCatalogProvisioningDetails={
        'ProductId': 'string',
        'ProvisioningArtifactId': 'string',
        'PathId': 'string',
        'ProvisioningParameters': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ]
    },
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    TemplateProviders=[
        {
            'CfnTemplateProvider': {
                'TemplateName': 'string',
                'TemplateURL': 'string',
                'RoleARN': 'string',
                'Parameters': [
                    {
                        'Key': 'string',
                        'Value': 'string'
                    },
                ]
            }
        },
    ]
)
type ProjectName:

string

param ProjectName:

[REQUIRED]

The name of the project.

type ProjectDescription:

string

param ProjectDescription:

A description for the project.

type ServiceCatalogProvisioningDetails:

dict

param ServiceCatalogProvisioningDetails:

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.

  • ProductId (string) -- [REQUIRED]

    The ID of the product to provision.

  • ProvisioningArtifactId (string) --

    The ID of the provisioning artifact.

  • PathId (string) --

    The path identifier of the product. This value is optional if the product has a default path, and required if the product has more than one path.

  • 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.

type Tags:

list

param Tags:

An array of key-value pairs that you want to use to organize and track your Amazon Web Services resource costs. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.

  • (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.

type TemplateProviders:

list

param TemplateProviders:

An array of template provider configurations for creating infrastructure resources for the project.

  • (dict) --

    Contains configuration details for a template provider. Only one type of template provider can be specified.

    • CfnTemplateProvider (dict) --

      The CloudFormation template provider configuration for creating infrastructure resources.

      • TemplateName (string) -- [REQUIRED]

        A unique identifier for the template within the project.

      • TemplateURL (string) -- [REQUIRED]

        The Amazon S3 URL of the CloudFormation template.

      • RoleARN (string) --

        The IAM role that CloudFormation assumes when creating the stack.

      • Parameters (list) --

        An array of CloudFormation stack parameters.

        • (dict) --

          A key-value pair that represents a parameter for the CloudFormation stack.

          • Key (string) -- [REQUIRED]

            The name of the CloudFormation parameter.

          • Value (string) --

            The value of the CloudFormation parameter.

rtype:

dict

returns:

Response Syntax

{
    'ProjectArn': 'string',
    'ProjectId': 'string'
}

Response Structure

  • (dict) --

    • ProjectArn (string) --

      The Amazon Resource Name (ARN) of the project.

    • ProjectId (string) --

      The ID of the new project.

DescribeProject (updated) Link ¶
Changes (response)
{'TemplateProviderDetails': [{'CfnTemplateProviderDetail': {'Parameters': [{'Key': 'string',
                                                                            'Value': 'string'}],
                                                            'RoleARN': 'string',
                                                            'StackDetail': {'Id': 'string',
                                                                            'Name': 'string',
                                                                            'StatusMessage': 'string'},
                                                            'TemplateName': 'string',
                                                            'TemplateURL': 'string'}}]}

Describes the details of a project.

See also: AWS API Documentation

Request Syntax

client.describe_project(
    ProjectName='string'
)
type ProjectName:

string

param ProjectName:

[REQUIRED]

The name of the project to describe.

rtype:

dict

returns:

Response Syntax

{
    'ProjectArn': 'string',
    'ProjectName': 'string',
    'ProjectId': 'string',
    'ProjectDescription': 'string',
    'ServiceCatalogProvisioningDetails': {
        'ProductId': 'string',
        'ProvisioningArtifactId': 'string',
        'PathId': 'string',
        'ProvisioningParameters': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ]
    },
    'ServiceCatalogProvisionedProductDetails': {
        'ProvisionedProductId': 'string',
        'ProvisionedProductStatusMessage': 'string'
    },
    'ProjectStatus': 'Pending'|'CreateInProgress'|'CreateCompleted'|'CreateFailed'|'DeleteInProgress'|'DeleteFailed'|'DeleteCompleted'|'UpdateInProgress'|'UpdateCompleted'|'UpdateFailed',
    'TemplateProviderDetails': [
        {
            'CfnTemplateProviderDetail': {
                'TemplateName': 'string',
                'TemplateURL': 'string',
                'RoleARN': 'string',
                'Parameters': [
                    {
                        'Key': 'string',
                        'Value': 'string'
                    },
                ],
                'StackDetail': {
                    'Name': 'string',
                    'Id': 'string',
                    'StatusMessage': 'string'
                }
            }
        },
    ],
    'CreatedBy': {
        'UserProfileArn': 'string',
        'UserProfileName': 'string',
        'DomainId': 'string',
        'IamIdentity': {
            'Arn': 'string',
            'PrincipalId': 'string',
            'SourceIdentity': 'string'
        }
    },
    'CreationTime': datetime(2015, 1, 1),
    'LastModifiedTime': datetime(2015, 1, 1),
    'LastModifiedBy': {
        'UserProfileArn': 'string',
        'UserProfileName': 'string',
        'DomainId': 'string',
        'IamIdentity': {
            'Arn': 'string',
            'PrincipalId': 'string',
            'SourceIdentity': 'string'
        }
    }
}

Response Structure

  • (dict) --

    • ProjectArn (string) --

      The Amazon Resource Name (ARN) of the project.

    • ProjectName (string) --

      The name of the project.

    • ProjectId (string) --

      The ID of the project.

    • ProjectDescription (string) --

      The description of the project.

    • ServiceCatalogProvisioningDetails (dict) --

      Information used to provision a service catalog product. For information, see What is Amazon Web Services Service Catalog.

      • ProductId (string) --

        The ID of the product to provision.

      • ProvisioningArtifactId (string) --

        The ID of the provisioning artifact.

      • PathId (string) --

        The path identifier of the product. This value is optional if the product has a default path, and required if the product has more than one path.

      • 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.

    • ServiceCatalogProvisionedProductDetails (dict) --

      Information about a provisioned service catalog product.

      • ProvisionedProductId (string) --

        The ID of the provisioned product.

      • ProvisionedProductStatusMessage (string) --

        The current status of the product.

        • AVAILABLE - Stable state, ready to perform any operation. The most recent operation succeeded and completed.

        • UNDER_CHANGE - Transitive state. Operations performed might not have valid results. Wait for an AVAILABLE status before performing operations.

        • TAINTED - Stable state, ready to perform any operation. The stack has completed the requested operation but is not exactly what was requested. For example, a request to update to a new version failed and the stack rolled back to the current version.

        • ERROR - An unexpected error occurred. The provisioned product exists but the stack is not running. For example, CloudFormation received a parameter value that was not valid and could not launch the stack.

        • PLAN_IN_PROGRESS - Transitive state. The plan operations were performed to provision a new product, but resources have not yet been created. After reviewing the list of resources to be created, execute the plan. Wait for an AVAILABLE status before performing operations.

    • ProjectStatus (string) --

      The status of the project.

    • TemplateProviderDetails (list) --

      An array of template providers associated with the project.

      • (dict) --

        Details about a template provider configuration and associated provisioning information.

        • CfnTemplateProviderDetail (dict) --

          Details about a CloudFormation template provider configuration and associated provisioning information.

          • TemplateName (string) --

            The unique identifier of the template within the project.

          • TemplateURL (string) --

            The Amazon S3 URL of the CloudFormation template.

          • RoleARN (string) --

            The IAM role used by CloudFormation to create the stack.

          • Parameters (list) --

            An array of CloudFormation stack parameters.

            • (dict) --

              A key-value pair representing a parameter used in the CloudFormation stack.

              • Key (string) --

                The name of the CloudFormation parameter.

              • Value (string) --

                The value of the CloudFormation parameter.

          • StackDetail (dict) --

            Information about the CloudFormation stack created by the template provider.

            • Name (string) --

              The name of the CloudFormation stack.

            • Id (string) --

              The unique identifier of the CloudFormation stack.

            • StatusMessage (string) --

              A human-readable message about the stack's current status.

    • CreatedBy (dict) --

      Information about the user who created or modified an experiment, trial, trial component, lineage group, project, or model card.

      • UserProfileArn (string) --

        The Amazon Resource Name (ARN) of the user's profile.

      • UserProfileName (string) --

        The name of the user's profile.

      • DomainId (string) --

        The domain associated with the user.

      • IamIdentity (dict) --

        The IAM Identity details associated with the user. These details are associated with model package groups, model packages, and project entities only.

        • Arn (string) --

          The Amazon Resource Name (ARN) of the IAM identity.

        • PrincipalId (string) --

          The ID of the principal that assumes the IAM identity.

        • SourceIdentity (string) --

          The person or application which assumes the IAM identity.

    • CreationTime (datetime) --

      The time when the project was created.

    • LastModifiedTime (datetime) --

      The timestamp when project was last modified.

    • LastModifiedBy (dict) --

      Information about the user who created or modified an experiment, trial, trial component, lineage group, project, or model card.

      • UserProfileArn (string) --

        The Amazon Resource Name (ARN) of the user's profile.

      • UserProfileName (string) --

        The name of the user's profile.

      • DomainId (string) --

        The domain associated with the user.

      • IamIdentity (dict) --

        The IAM Identity details associated with the user. These details are associated with model package groups, model packages, and project entities only.

        • Arn (string) --

          The Amazon Resource Name (ARN) of the IAM identity.

        • PrincipalId (string) --

          The ID of the principal that assumes the IAM identity.

        • SourceIdentity (string) --

          The person or application which assumes the IAM identity.

UpdateProject (updated) Link ¶
Changes (request)
{'TemplateProvidersToUpdate': [{'CfnTemplateProvider': {'Parameters': [{'Key': 'string',
                                                                        'Value': 'string'}],
                                                        'TemplateName': 'string',
                                                        'TemplateURL': 'string'}}]}

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.

See also: AWS API Documentation

Request Syntax

client.update_project(
    ProjectName='string',
    ProjectDescription='string',
    ServiceCatalogProvisioningUpdateDetails={
        'ProvisioningArtifactId': 'string',
        'ProvisioningParameters': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ]
    },
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    TemplateProvidersToUpdate=[
        {
            'CfnTemplateProvider': {
                'TemplateName': 'string',
                'TemplateURL': 'string',
                'Parameters': [
                    {
                        'Key': 'string',
                        'Value': 'string'
                    },
                ]
            }
        },
    ]
)
type ProjectName:

string

param ProjectName:

[REQUIRED]

The name of the project.

type ProjectDescription:

string

param ProjectDescription:

The description for the project.

type ServiceCatalogProvisioningUpdateDetails:

dict

param 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 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.

type Tags:

list

param Tags:

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.

type TemplateProvidersToUpdate:

list

param TemplateProvidersToUpdate:

The template providers to update in the project.

  • (dict) --

    Contains configuration details for updating an existing template provider in the project.

    • CfnTemplateProvider (dict) --

      The CloudFormation template provider configuration to update.

      • TemplateName (string) -- [REQUIRED]

        The unique identifier of the template to update within the project.

      • TemplateURL (string) -- [REQUIRED]

        The Amazon S3 URL of the CloudFormation template.

      • Parameters (list) --

        An array of CloudFormation stack parameters.

        • (dict) --

          A key-value pair representing a parameter used in the CloudFormation stack.

          • Key (string) -- [REQUIRED]

            The name of the CloudFormation parameter.

          • Value (string) --

            The value of the CloudFormation parameter.

rtype:

dict

returns:

Response Syntax

{
    'ProjectArn': 'string'
}

Response Structure

  • (dict) --

    • ProjectArn (string) --

      The Amazon Resource Name (ARN) of the project.