Skip to content

List Workflows

customerprofiles_list_workflows R Documentation

Query to list all workflows

Description

Query to list all workflows.

Usage

customerprofiles_list_workflows(DomainName, WorkflowType, Status,
  QueryStartDate, QueryEndDate, NextToken, MaxResults)

Arguments

DomainName

[required] The unique name of the domain.

WorkflowType

The type of workflow. The only supported value is APPFLOW_INTEGRATION.

Status

Status of workflow execution.

QueryStartDate

Retrieve workflows started after timestamp.

QueryEndDate

Retrieve workflows ended after timestamp.

NextToken

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

MaxResults

The maximum number of results to return per page.

Value

A list with the following syntax:

list(
  Items = list(
    list(
      WorkflowType = "APPFLOW_INTEGRATION",
      WorkflowId = "string",
      Status = "NOT_STARTED"|"IN_PROGRESS"|"COMPLETE"|"FAILED"|"SPLIT"|"RETRY"|"CANCELLED",
      StatusDescription = "string",
      CreatedAt = as.POSIXct(
        "2015-01-01"
      ),
      LastUpdatedAt = as.POSIXct(
        "2015-01-01"
      )
    )
  ),
  NextToken = "string"
)

Request syntax

svc$list_workflows(
  DomainName = "string",
  WorkflowType = "APPFLOW_INTEGRATION",
  Status = "NOT_STARTED"|"IN_PROGRESS"|"COMPLETE"|"FAILED"|"SPLIT"|"RETRY"|"CANCELLED",
  QueryStartDate = as.POSIXct(
    "2015-01-01"
  ),
  QueryEndDate = as.POSIXct(
    "2015-01-01"
  ),
  NextToken = "string",
  MaxResults = 123
)