List Workflow Runs

codecatalyst_list_workflow_runs

R Documentation

Retrieves a list of workflow runs of a specified workflow¶

Description¶

Retrieves a list of workflow runs of a specified workflow.

Usage¶

codecatalyst_list_workflow_runs(spaceName, workflowId, projectName,
  nextToken, maxResults, sortBy)

Arguments¶

spaceName

[required] The name of the space.

workflowId

The ID of the workflow. To retrieve a list of workflow IDs, use list_workflows.

projectName

[required] The name of the project in the space.

nextToken

A token returned from a call to this API to indicate the next batch of results to return, if any.

maxResults

The maximum number of results to show in a single call to this API. If the number of results is larger than the number you specified, the response will include a NextToken element, which you can use to obtain additional results.

sortBy

Information used to sort the items in the returned list.

Value¶

A list with the following syntax:

list(
  nextToken = "string",
  items = list(
    list(
      id = "string",
      workflowId = "string",
      workflowName = "string",
      status = "SUCCEEDED"|"FAILED"|"STOPPED"|"SUPERSEDED"|"CANCELLED"|"NOT_RUN"|"VALIDATING"|"PROVISIONING"|"IN_PROGRESS"|"STOPPING"|"ABANDONED",
      statusReasons = list(
        list()
      ),
      startTime = as.POSIXct(
        "2015-01-01"
      ),
      endTime = as.POSIXct(
        "2015-01-01"
      ),
      lastUpdatedTime = as.POSIXct(
        "2015-01-01"
      )
    )
  )
)

Request syntax¶

svc$list_workflow_runs(
  spaceName = "string",
  workflowId = "string",
  projectName = "string",
  nextToken = "string",
  maxResults = 123,
  sortBy = list(
    list()
  )
)