Skip to content

Describe Pipeline

sagemaker_describe_pipeline R Documentation

Describes the details of a pipeline

Description

Describes the details of a pipeline.

Usage

sagemaker_describe_pipeline(PipelineName)

Arguments

PipelineName

[required] The name or Amazon Resource Name (ARN) of the pipeline to describe.

Value

A list with the following syntax: 

list(
  PipelineArn = "string",
  PipelineName = "string",
  PipelineDisplayName = "string",
  PipelineDefinition = "string",
  PipelineDescription = "string",
  RoleArn = "string",
  PipelineStatus = "Active"|"Deleting",
  CreationTime = as.POSIXct(
    "2015-01-01"
  ),
  LastModifiedTime = as.POSIXct(
    "2015-01-01"
  ),
  LastRunTime = as.POSIXct(
    "2015-01-01"
  ),
  CreatedBy = list(
    UserProfileArn = "string",
    UserProfileName = "string",
    DomainId = "string",
    IamIdentity = list(
      Arn = "string",
      PrincipalId = "string",
      SourceIdentity = "string"
    )
  ),
  LastModifiedBy = list(
    UserProfileArn = "string",
    UserProfileName = "string",
    DomainId = "string",
    IamIdentity = list(
      Arn = "string",
      PrincipalId = "string",
      SourceIdentity = "string"
    )
  ),
  ParallelismConfiguration = list(
    MaxParallelExecutionSteps = 123
  )
)

Request syntax

svc$describe_pipeline(
  PipelineName = "string"
)