Skip to content

List Pipelines

sagemaker_list_pipelines R Documentation

Gets a list of pipelines

Description

Gets a list of pipelines.

Usage

sagemaker_list_pipelines(PipelineNamePrefix, CreatedAfter,
  CreatedBefore, SortBy, SortOrder, NextToken, MaxResults)

Arguments

PipelineNamePrefix

The prefix of the pipeline name.

CreatedAfter

A filter that returns the pipelines that were created after a specified time.

CreatedBefore

A filter that returns the pipelines that were created before a specified time.

SortBy

The field by which to sort results. The default is CreatedTime.

SortOrder

The sort order for results.

NextToken

If the result of the previous list_pipelines request was truncated, the response includes a NextToken. To retrieve the next set of pipelines, use the token in the next request.

MaxResults

The maximum number of pipelines to return in the response.

Value

A list with the following syntax:

list(
  PipelineSummaries = list(
    list(
      PipelineArn = "string",
      PipelineName = "string",
      PipelineDisplayName = "string",
      PipelineDescription = "string",
      RoleArn = "string",
      CreationTime = as.POSIXct(
        "2015-01-01"
      ),
      LastModifiedTime = as.POSIXct(
        "2015-01-01"
      ),
      LastExecutionTime = as.POSIXct(
        "2015-01-01"
      )
    )
  ),
  NextToken = "string"
)

Request syntax

svc$list_pipelines(
  PipelineNamePrefix = "string",
  CreatedAfter = as.POSIXct(
    "2015-01-01"
  ),
  CreatedBefore = as.POSIXct(
    "2015-01-01"
  ),
  SortBy = "Name"|"CreationTime",
  SortOrder = "Ascending"|"Descending",
  NextToken = "string",
  MaxResults = 123
)