Skip to content

CreatePipelineRequest

Source code in docs_src/capo_sagemaker/types/create_pipeline_request.py
class CreatePipelineRequest(TypedDict, closed=True):
    pipeline_name: NotRequired["capo_sagemaker.types.pipeline_name.PipelineName"]
    """<p>The name of the pipeline.</p>"""
    pipeline_display_name: NotRequired[
        "capo_sagemaker.types.pipeline_name.PipelineName"
    ]
    """<p>The display name of the pipeline.</p>"""
    pipeline_definition: NotRequired[
        "capo_sagemaker.types.pipeline_definition.PipelineDefinition"
    ]
    """<p>The <a href="https://aws-sagemaker-mlops.github.io/sagemaker-model-building-pipeline-definition-JSON-schema/">JSON pipeline definition</a> of the pipeline.</p>"""
    pipeline_definition_s3_location: NotRequired[
        "capo_sagemaker.types.pipeline_definition_s3_location.PipelineDefinitionS3Location"
    ]
    """<p>The location of the pipeline definition stored in Amazon S3. If specified, SageMaker will retrieve the pipeline definition from this location.</p>"""
    pipeline_description: NotRequired[
        "capo_sagemaker.types.pipeline_description.PipelineDescription"
    ]
    """<p>A description of the pipeline.</p>"""
    client_request_token: NotRequired[
        "capo_sagemaker.types.idempotency_token.IdempotencyToken"
    ]
    """<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than one time.</p>"""
    role_arn: NotRequired["capo_sagemaker.types.role_arn.RoleArn"]
    """<p>The Amazon Resource Name (ARN) of the role used by the pipeline to access and create resources.</p>"""
    tags: NotRequired["capo_sagemaker.types.tag_list.TagList"]
    """<p>A list of tags to apply to the created pipeline.</p>"""
    parallelism_configuration: NotRequired[
        "capo_sagemaker.types.parallelism_configuration.ParallelismConfiguration"
    ]
    """<p>This is the configuration that controls the parallelism of the pipeline. If specified, it applies to all runs of this pipeline by default.</p>"""

client_request_token instance-attribute

client_request_token: NotRequired[IdempotencyToken]

A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than one time.

parallelism_configuration instance-attribute

parallelism_configuration: NotRequired[ParallelismConfiguration]

This is the configuration that controls the parallelism of the pipeline. If specified, it applies to all runs of this pipeline by default.

pipeline_definition instance-attribute

pipeline_definition: NotRequired[PipelineDefinition]

The JSON pipeline definition of the pipeline.

pipeline_definition_s3_location instance-attribute

pipeline_definition_s3_location: NotRequired[PipelineDefinitionS3Location]

The location of the pipeline definition stored in Amazon S3. If specified, SageMaker will retrieve the pipeline definition from this location.

pipeline_description instance-attribute

pipeline_description: NotRequired[PipelineDescription]

A description of the pipeline.

pipeline_display_name instance-attribute

pipeline_display_name: NotRequired[PipelineName]

The display name of the pipeline.

pipeline_name instance-attribute

pipeline_name: NotRequired[PipelineName]

The name of the pipeline.

role_arn instance-attribute

role_arn: NotRequired[RoleArn]

The Amazon Resource Name (ARN) of the role used by the pipeline to access and create resources.

tags instance-attribute

tags: NotRequired[TagList]

A list of tags to apply to the created pipeline.