projects

Creates, updates, deletes, gets or lists a projects resource.

Overview

Name	projects
Type	Resource
Id	aws.sagemaker.projects

Fields

The following fields are returned by SELECT queries:

describe_project

Name	Datatype	Description
created_by	object	Information about the user who created or modified a SageMaker resource.
creation_time	string (date-time)	The time when the project was created.
last_modified_by	object	Information about the user who created or modified a SageMaker resource.
last_modified_time	string (date-time)	The timestamp when project was last modified.
project_arn	string	The Amazon Resource Name (ARN) of the project. (pattern: <code>arn:aws[a-z-]*:sagemaker:[a-z0-9-]{9,16}:[0-9]{12}:project/[\S]{1,2048}</code>)
project_description	string	The description of the project. (pattern: <code>[\p{L}\p{M}\p{Z}\p{S}\p{N}\p{P}]*</code>)
project_id	string	The ID of the project. (pattern: <code>[a-zA-Z0-9](-[a-zA-Z0-9])</code>)
project_name	string	The name of the project. (pattern: <code>[a-zA-Z0-9](-*[a-zA-Z0-9]){0,31}</code>)
project_status	string	The status of the project. (Pending, CreateInProgress, CreateCompleted, CreateFailed, DeleteInProgress, DeleteFailed, DeleteCompleted, UpdateInProgress, UpdateCompleted, UpdateFailed)
service_catalog_provisioned_product_details	object	Information about a provisioned service catalog product.
service_catalog_provisioning_details	object	Information used to provision a service catalog product. For information, see What is Amazon Web Services Service Catalog.
template_provider_details	array	An array of template providers associated with the project.

list_projects

Name	Datatype	Description
next_token	string	If the result of the previous ListCompilationJobs request was truncated, the response includes a NextToken. To retrieve the next set of model compilation jobs, use the token in the next request. (pattern: <code>.*</code>)
project_summary_list	array	A list of summaries of projects.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_project	select	region		Describes the details of a project.
list_projects	select	region		Gets a list of the projects in an Amazon Web Services account.
create_project	insert	region, ProjectName		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.
update_project	update	region, ProjectName		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.
delete_project	delete	region		Delete the specified project.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

describe_project

Describes the details of a project.

SELECT
created_by,
creation_time,
last_modified_by,
last_modified_time,
project_arn,
project_description,
project_id,
project_name,
project_status,
service_catalog_provisioned_product_details,
service_catalog_provisioning_details,
template_provider_details
FROM aws.sagemaker.projects
WHERE region = '{{ region }}' -- required
;

list_projects

Gets a list of the projects in an Amazon Web Services account.

SELECT
next_token,
project_summary_list
FROM aws.sagemaker.projects
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_project

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.

INSERT INTO aws.sagemaker.projects (
ProjectName,
ProjectDescription,
ServiceCatalogProvisioningDetails,
Tags,
TemplateProviders,
region
)
SELECT 
'{{ ProjectName }}' /* required */,
'{{ ProjectDescription }}',
'{{ ServiceCatalogProvisioningDetails }}',
'{{ Tags }}',
'{{ TemplateProviders }}',
'{{ region }}'
RETURNING
project_arn,
project_id
;

Manifest

# Description fields are for documentation purposes
- name: projects
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the projects resource.
  - name: ProjectName
    value: "{{ ProjectName }}"
    description: |
      The name of the project.
  - name: ProjectDescription
    value: "{{ ProjectDescription }}"
    description: |
      A description for the project.
  - name: ServiceCatalogProvisioningDetails
    description: |
      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.
    value:
      ProductId: "{{ ProductId }}"
      ProvisioningArtifactId: "{{ ProvisioningArtifactId }}"
      PathId: "{{ PathId }}"
      ProvisioningParameters:
        - Key: "{{ Key }}"
          Value: "{{ Value }}"
  - name: Tags
    description: |
      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.
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"
  - name: TemplateProviders
    description: |
      An array of template provider configurations for creating infrastructure resources for the project.
    value:
      - CfnTemplateProvider:
          TemplateName: "{{ TemplateName }}"
          TemplateURL: "{{ TemplateURL }}"
          RoleARN: "{{ RoleARN }}"
          Parameters:
            - Key: "{{ Key }}"
              Value: "{{ Value }}"

UPDATE examples

update_project

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.

UPDATE aws.sagemaker.projects
SET 
ProjectName = '{{ ProjectName }}',
ProjectDescription = '{{ ProjectDescription }}',
ServiceCatalogProvisioningUpdateDetails = '{{ ServiceCatalogProvisioningUpdateDetails }}',
Tags = '{{ Tags }}',
TemplateProvidersToUpdate = '{{ TemplateProvidersToUpdate }}'
WHERE 
region = '{{ region }}' --required
AND ProjectName = '{{ ProjectName }}' --required
RETURNING
project_arn;

DELETE examples

delete_project

Delete the specified project.

DELETE FROM aws.sagemaker.projects
WHERE region = '{{ region }}' --required
;