pipelines

Creates, updates, deletes or gets a pipeline resource or lists pipelines in a region

Overview

Name	pipelines
Type	Resource
Description	Resource Type definition for AWS::SageMaker::Pipeline
Id	aws.sagemaker.pipelines

Fields

Name	Datatype	Description
pipeline_name	string	The name of the Pipeline.
pipeline_display_name	string	The display name of the Pipeline.
pipeline_description	string	The description of the Pipeline.
pipeline_definition	object
role_arn	string	Role Arn
tags	array
parallelism_configuration	object
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	PipelineName, PipelineDefinition, RoleArn, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all pipelines in a region.

SELECT
region,
pipeline_name,
pipeline_display_name,
pipeline_description,
pipeline_definition,
role_arn,
tags,
parallelism_configuration
FROM aws.sagemaker.pipelines
WHERE region = 'us-east-1';

Gets all properties from an individual pipeline.

SELECT
region,
pipeline_name,
pipeline_display_name,
pipeline_description,
pipeline_definition,
role_arn,
tags,
parallelism_configuration
FROM aws.sagemaker.pipelines
WHERE region = 'us-east-1' AND data__Identifier = '<PipelineName>';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO aws.sagemaker.pipelines (
 PipelineName,
 PipelineDefinition,
 RoleArn,
 region
)
SELECT 
'{{ PipelineName }}',
 '{{ PipelineDefinition }}',
 '{{ RoleArn }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.sagemaker.pipelines (
 PipelineName,
 PipelineDisplayName,
 PipelineDescription,
 PipelineDefinition,
 RoleArn,
 Tags,
 ParallelismConfiguration,
 region
)
SELECT 
 '{{ PipelineName }}',
 '{{ PipelineDisplayName }}',
 '{{ PipelineDescription }}',
 '{{ PipelineDefinition }}',
 '{{ RoleArn }}',
 '{{ Tags }}',
 '{{ ParallelismConfiguration }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: pipeline
    props:
      - name: PipelineName
        value: '{{ PipelineName }}'
      - name: PipelineDisplayName
        value: '{{ PipelineDisplayName }}'
      - name: PipelineDescription
        value: '{{ PipelineDescription }}'
      - name: PipelineDefinition
        value: {}
      - name: RoleArn
        value: '{{ RoleArn }}'
      - name: Tags
        value:
          - Value: '{{ Value }}'
            Key: '{{ Key }}'
      - name: ParallelismConfiguration
        value:
          MaxParallelExecutionSteps: '{{ MaxParallelExecutionSteps }}'

DELETE example

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

Permissions

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

Create

iam:PassRole,
s3:GetObject,
sagemaker:CreatePipeline,
sagemaker:DescribePipeline,
sagemaker:AddTags,
sagemaker:ListTags

Read

sagemaker:DescribePipeline,
sagemaker:ListTags

Update

iam:PassRole,
s3:GetObject,
sagemaker:UpdatePipeline,
sagemaker:DescribePipeline,
sagemaker:AddTags,
sagemaker:DeleteTags,
sagemaker:ListTags

Delete

sagemaker:DeletePipeline

List

sagemaker:ListPipelines