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	awscc.sagemaker.projects

Fields

get (all properties)

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
▶template_provider_details	array	An array of template providers associated with the project.
project_status	string	The status of a project.
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
project_arn	string	The Amazon Resource Name (ARN) of the Project.
region	string	AWS region.

For more information, see AWS::SageMaker::Project.

Methods

Name	Resource	Accessible by	Required Params
create_resource	projects	INSERT	ProjectName, region
delete_resource	projects	DELETE	Identifier, region
update_resource	projects	UPDATE	Identifier, PatchDocument, region
list_resources	projects_list_only	SELECT	region
get_resource	projects	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual project.

SELECT
  region,
  tags,
  project_arn,
  project_id,
  project_name,
  project_description,
  creation_time,
  service_catalog_provisioning_details,
  service_catalog_provisioned_product_details,
  template_provider_details,
  project_status
FROM awscc.sagemaker.projects
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ project_arn }}';

list (identifiers only)

Lists all projects in a region.

SELECT
  region,
  project_arn
FROM awscc.sagemaker.projects_list_only
WHERE
  region = 'us-east-1';

INSERT example

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

Required Properties

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

All Properties

/*+ create */
INSERT INTO awscc.sagemaker.projects (
  Tags,
  ProjectName,
  ProjectDescription,
  ServiceCatalogProvisioningDetails,
  ServiceCatalogProvisionedProductDetails,
  TemplateProviderDetails,
  region
)
SELECT
  '{{ tags }}',
  '{{ project_name }}',
  '{{ project_description }}',
  '{{ service_catalog_provisioning_details }}',
  '{{ service_catalog_provisioned_product_details }}',
  '{{ template_provider_details }}',
  '{{ 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: project_name
        value: '{{ project_name }}'
      - name: project_description
        value: '{{ project_description }}'
      - name: service_catalog_provisioning_details
        value:
          product_id: '{{ product_id }}'
          provisioning_artifact_id: '{{ provisioning_artifact_id }}'
          path_id: '{{ path_id }}'
          provisioning_parameters:
            - key: '{{ key }}'
              value: '{{ value }}'
      - name: service_catalog_provisioned_product_details
        value:
          provisioned_product_id: null
          provisioned_product_status_message: '{{ provisioned_product_status_message }}'
      - name: template_provider_details
        value:
          - cfn_template_provider_detail:
              parameters:
                - key: '{{ key }}'
                  value: '{{ value }}'
              role_arn: '{{ role_arn }}'
              template_name: '{{ template_name }}'
              template_url: '{{ template_url }}'

UPDATE example

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

/*+ update */
UPDATE awscc.sagemaker.projects
SET PatchDocument = string('{{ {
    "ServiceCatalogProvisionedProductDetails": service_catalog_provisioned_product_details
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ project_arn }}';

DELETE example

/*+ delete */
DELETE FROM awscc.sagemaker.projects
WHERE
  Identifier = '{{ project_arn }}' 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,
cloudformation:DescribeStacks,
cloudformation:CreateStack,
iam:PassRole,
s3:GetObject

Read

sagemaker:DescribeProject,
sagemaker:ListTags

Update

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

Delete

sagemaker:DeleteProject,
sagemaker:DescribeProject,
servicecatalog:TerminateProvisionedProduct,
servicecatalog:DescribeRecord,
cloudformation:DescribeStacks,
cloudformation:DeleteStack

List

sagemaker:ListProjects