List Pipeline Executions

sagemaker_list_pipeline_executions

R Documentation

Gets a list of the pipeline executions

Description

Gets a list of the pipeline executions.

Usage

sagemaker_list_pipeline_executions(PipelineName, CreatedAfter,
  CreatedBefore, SortBy, SortOrder, NextToken, MaxResults)

Arguments

PipelineName

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

CreatedAfter

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

CreatedBefore

A filter that returns the pipeline executions 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_pipeline_executions request was truncated, the response includes a NextToken. To retrieve the next set of pipeline executions, use the token in the next request.

MaxResults

The maximum number of pipeline executions to return in the response.

Value

A list with the following syntax:

list(
  PipelineExecutionSummaries = list(
    list(
      PipelineExecutionArn = "string",
      StartTime = as.POSIXct(
        "2015-01-01"
      ),
      PipelineExecutionStatus = "Executing"|"Stopping"|"Stopped"|"Failed"|"Succeeded",
      PipelineExecutionDescription = "string",
      PipelineExecutionDisplayName = "string",
      PipelineExecutionFailureReason = "string"
    )
  ),
  NextToken = "string"
)

Request syntax

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