projects

Creates, updates, deletes or gets a project resource or lists projects in a region

Overview

Name	projects
Type	Resource
Description	Resource Type definition for AWS::SageMaker::Project
Id	aws.sagemaker.projects

Fields

Name	Datatype	Description
tags	array	An array of key-value pairs to apply to this resource.
project_arn	string	The Amazon Resource Name (ARN) of the Project.
project_id	string	Project Id.
project_name	string	The name of the project.
project_description	string	The description of the project.
creation_time	string	The time at which the project was created.
service_catalog_provisioning_details	object	Input ServiceCatalog Provisioning Details
service_catalog_provisioned_product_details	object	Provisioned ServiceCatalog Details
project_status	string	The status of a project.
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	ProjectName, ServiceCatalogProvisioningDetails, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resource	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

List all projects in a region.

SELECT
region,
project_arn
FROM aws.sagemaker.projects
WHERE region = 'us-east-1';

Gets all properties from a project.

SELECT
region,
tags,
project_arn,
project_id,
project_name,
project_description,
creation_time,
service_catalog_provisioning_details,
service_catalog_provisioned_product_details,
project_status
FROM aws.sagemaker.projects
WHERE region = 'us-east-1' AND data__Identifier = '<ProjectArn>';

INSERT example

Use the following StackQL query and manifest file to create a new project resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO aws.sagemaker.projects (
 ProjectName,
 ServiceCatalogProvisioningDetails,
 region
)
SELECT 
'{{ ProjectName }}',
 '{{ ServiceCatalogProvisioningDetails }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.sagemaker.projects (
 Tags,
 ProjectName,
 ProjectDescription,
 ServiceCatalogProvisioningDetails,
 ServiceCatalogProvisionedProductDetails,
 region
)
SELECT 
 '{{ Tags }}',
 '{{ ProjectName }}',
 '{{ ProjectDescription }}',
 '{{ ServiceCatalogProvisioningDetails }}',
 '{{ ServiceCatalogProvisionedProductDetails }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: project
    props:
      - name: Tags
        value:
          - Value: '{{ Value }}'
            Key: '{{ Key }}'
      - name: ProjectName
        value: '{{ ProjectName }}'
      - name: ProjectDescription
        value: '{{ ProjectDescription }}'
      - name: ServiceCatalogProvisioningDetails
        value:
          ProductId: '{{ ProductId }}'
          ProvisioningArtifactId: '{{ ProvisioningArtifactId }}'
          PathId: '{{ PathId }}'
          ProvisioningParameters:
            - Key: '{{ Key }}'
              Value: '{{ Value }}'
      - name: ServiceCatalogProvisionedProductDetails
        value:
          ProvisionedProductId: null
          ProvisionedProductStatusMessage: '{{ ProvisionedProductStatusMessage }}'

DELETE example

/*+ delete */
DELETE FROM aws.sagemaker.projects
WHERE data__Identifier = '<ProjectArn>'
AND region = 'us-east-1';

Permissions

To operate on the projects resource, the following permissions are required:

Create

sagemaker:AddTags,
sagemaker:CreateProject,
sagemaker:DescribeProject,
sagemaker:ListTags,
servicecatalog:DescribeProduct,
servicecatalog:DescribeProvisioningArtifact,
servicecatalog:ProvisionProduct,
servicecatalog:DescribeProvisionedProduct,
servicecatalog:TerminateProvisionedProduct

Read

sagemaker:DescribeProject,
sagemaker:ListTags

Update

sagemaker:DescribeProject,
sagemaker:ListTags,
sagemaker:AddTags,
sagemaker:DeleteTags

Delete

sagemaker:DeleteProject,
sagemaker:DescribeProject,
servicecatalog:TerminateProvisionedProduct,
servicecatalog:DescribeRecord

List

sagemaker:ListProjects