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

Fields

get (all properties)

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.

list (identifiers only)

Name	Datatype	Description
pipeline_name	string	The name of the Pipeline.
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	pipelines	INSERT	PipelineName, PipelineDefinition, RoleArn, region
delete_resource	pipelines	DELETE	Identifier, region
update_resource	pipelines	UPDATE	Identifier, PatchDocument, region
list_resources	pipelines_list_only	SELECT	region
get_resource	pipelines	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual pipeline.

SELECT
  region,
  pipeline_name,
  pipeline_display_name,
  pipeline_description,
  pipeline_definition,
  role_arn,
  tags,
  parallelism_configuration
FROM awscc.sagemaker.pipelines
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ pipeline_name }}';

list (identifiers only)

Lists all pipelines in a region.

SELECT
  region,
  pipeline_name
FROM awscc.sagemaker.pipelines_list_only
WHERE
  region = 'us-east-1';

INSERT example

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

Required Properties

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

All Properties

/*+ create */
INSERT INTO awscc.sagemaker.pipelines (
  PipelineName,
  PipelineDisplayName,
  PipelineDescription,
  PipelineDefinition,
  RoleArn,
  Tags,
  ParallelismConfiguration,
  region
)
SELECT
  '{{ pipeline_name }}',
  '{{ pipeline_display_name }}',
  '{{ pipeline_description }}',
  '{{ pipeline_definition }}',
  '{{ role_arn }}',
  '{{ tags }}',
  '{{ parallelism_configuration }}',
  '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: pipeline
    props:
      - name: pipeline_name
        value: '{{ pipeline_name }}'
      - name: pipeline_display_name
        value: '{{ pipeline_display_name }}'
      - name: pipeline_description
        value: '{{ pipeline_description }}'
      - name: pipeline_definition
        value: {}
      - name: role_arn
        value: '{{ role_arn }}'
      - name: tags
        value:
          - value: '{{ value }}'
            key: '{{ key }}'
      - name: parallelism_configuration
        value:
          max_parallel_execution_steps: '{{ max_parallel_execution_steps }}'

UPDATE example

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

/*+ update */
UPDATE awscc.sagemaker.pipelines
SET PatchDocument = string('{{ {
    "PipelineDisplayName": pipeline_display_name,
    "PipelineDescription": pipeline_description,
    "PipelineDefinition": pipeline_definition,
    "RoleArn": role_arn,
    "Tags": tags,
    "ParallelismConfiguration": parallelism_configuration
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ pipeline_name }}';

DELETE example

/*+ delete */
DELETE FROM awscc.sagemaker.pipelines
WHERE
  Identifier = '{{ pipeline_name }}' 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