Pipeline
sagemaker.services.k8s.aws/v1alpha1
| Type | Link |
|---|---|
| GoDoc | sagemaker-controller/apis/v1alpha1#Pipeline |
Metadata
| Property | Value |
|---|---|
| Scope | Namespaced |
| Kind | Pipeline |
| ListKind | PipelineList |
| Plural | pipelines |
| Singular | pipeline |
A SageMaker Model Building Pipeline instance.
Spec
parallelismConfiguration:
maxParallelExecutionSteps: integer
pipelineDefinition: string
pipelineDescription: string
pipelineDisplayName: string
pipelineName: string
roleARN: string
tags:
- key: string
value: string
| Field | Description |
|---|---|
| parallelismConfiguration Optional | object This is the configuration that controls the parallelism of the pipeline. If specified, it applies to all runs of this pipeline by default. |
| parallelismConfiguration.maxParallelExecutionSteps Optional | integer |
| pipelineDefinition Optional | string The JSON pipeline definition (https://aws-sagemaker-mlops.github.io/sagemaker-model-building-pipeline-definition-JSON-schema/) of the pipeline. |
| pipelineDescription Optional | string A description of the pipeline. |
| pipelineDisplayName Optional | string The display name of the pipeline. |
| pipelineName Required | string The name of the pipeline. |
| roleARN Required | string The Amazon Resource Name (ARN) of the role used by the pipeline to access and create resources. |
| tags Optional | array A list of tags to apply to the created pipeline. |
| tags.[] Required | object A tag object that consists of a key and an optional value, used to manage |
| metadata for SageMaker Amazon Web Services resources. |
You can add tags to notebook instances, training jobs, hyperparameter tuning jobs, batch transform jobs, models, labeling jobs, work teams, endpoint configurations, and endpoints. For more information on adding tags to SageMaker resources, see AddTags (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_AddTags.html).
For more information on adding metadata to your Amazon Web Services resources
with tagging, see Tagging Amazon Web Services resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html).
For advice on best practices for managing Amazon Web Services resources with
tagging, see Tagging Best Practices: Implement an Effective Amazon Web Services
Resource Tagging Strategy (https://d1.awsstatic.com/whitepapers/aws-tagging-best-practices.pdf). || tags.[].key
Optional | string
|
| tags.[].value
Optional | string
|
Status
ackResourceMetadata:
arn: string
ownerAccountID: string
region: string
conditions:
- lastTransitionTime: string
message: string
reason: string
status: string
type: string
creationTime: string
lastModifiedTime: string
pipelineStatus: string
| Field | Description |
|---|---|
| ackResourceMetadata Optional | object All CRs managed by ACK have a common Status.ACKResourceMetadata memberthat is used to contain resource sync state, account ownership, constructed ARN for the resource |
| ackResourceMetadata.arn Optional | string ARN is the Amazon Resource Name for the resource. This is a globally-unique identifier and is set only by the ACK service controller once the controller has orchestrated the creation of the resource OR when it has verified that an “adopted” resource (a resource where the ARN annotation was set by the Kubernetes user on the CR) exists and matches the supplied CR’s Spec field values. TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse https://github.com/aws/aws-controllers-k8s/issues/270 |
| ackResourceMetadata.ownerAccountID Required | string OwnerAccountID is the AWS Account ID of the account that owns the backend AWS service API resource. |
| ackResourceMetadata.region Required | string Region is the AWS region in which the resource exists or will exist. |
| conditions Optional | array All CRS managed by ACK have a common Status.Conditions member thatcontains a collection of ackv1alpha1.Condition objects that describethe various terminal states of the CR and its backend AWS service API resource |
| conditions.[] Required | object Condition is the common struct used by all CRDs managed by ACK service |
| controllers to indicate terminal states of the CR and its backend AWS | |
| service API resource | |
| conditions.[].message Optional | string A human readable message indicating details about the transition. |
| conditions.[].reason Optional | string The reason for the condition’s last transition. |
| conditions.[].status Optional | string Status of the condition, one of True, False, Unknown. |
| conditions.[].type Optional | string Type is the type of the Condition |
| creationTime Optional | string The time when the pipeline was created. |
| lastModifiedTime Optional | string The time when the pipeline was last modified. |
| pipelineStatus Optional | string The status of the pipeline execution. |