Get Workflow Run

glue_get_workflow_run

R Documentation

Retrieves the metadata for a given workflow run

Description

Retrieves the metadata for a given workflow run. Job run history is accessible for 90 days for your workflow and job run.

Usage

glue_get_workflow_run(Name, RunId, IncludeGraph)

Arguments

Name

[required] Name of the workflow being run.

RunId

[required] The ID of the workflow run.

IncludeGraph

Specifies whether to include the workflow graph in response or not.

Value

A list with the following syntax:

list(
  Run = list(
    Name = "string",
    WorkflowRunId = "string",
    PreviousRunId = "string",
    WorkflowRunProperties = list(
      "string"
    ),
    StartedOn = as.POSIXct(
      "2015-01-01"
    ),
    CompletedOn = as.POSIXct(
      "2015-01-01"
    ),
    Status = "RUNNING"|"COMPLETED"|"STOPPING"|"STOPPED"|"ERROR",
    ErrorMessage = "string",
    Statistics = list(
      TotalActions = 123,
      TimeoutActions = 123,
      FailedActions = 123,
      StoppedActions = 123,
      SucceededActions = 123,
      RunningActions = 123,
      ErroredActions = 123,
      WaitingActions = 123
    ),
    Graph = list(
      Nodes = list(
        list(
          Type = "CRAWLER"|"JOB"|"TRIGGER",
          Name = "string",
          UniqueId = "string",
          TriggerDetails = list(
            Trigger = list(
              Name = "string",
              WorkflowName = "string",
              Id = "string",
              Type = "SCHEDULED"|"CONDITIONAL"|"ON_DEMAND"|"EVENT",
              State = "CREATING"|"CREATED"|"ACTIVATING"|"ACTIVATED"|"DEACTIVATING"|"DEACTIVATED"|"DELETING"|"UPDATING",
              Description = "string",
              Schedule = "string",
              Actions = list(
                list(
                  JobName = "string",
                  Arguments = list(
                    "string"
                  ),
                  Timeout = 123,
                  SecurityConfiguration = "string",
                  NotificationProperty = list(
                    NotifyDelayAfter = 123
                  ),
                  CrawlerName = "string"
                )
              ),
              Predicate = list(
                Logical = "AND"|"ANY",
                Conditions = list(
                  list(
                    LogicalOperator = "EQUALS",
                    JobName = "string",
                    State = "STARTING"|"RUNNING"|"STOPPING"|"STOPPED"|"SUCCEEDED"|"FAILED"|"TIMEOUT"|"ERROR"|"WAITING"|"EXPIRED",
                    CrawlerName = "string",
                    CrawlState = "RUNNING"|"CANCELLING"|"CANCELLED"|"SUCCEEDED"|"FAILED"|"ERROR"
                  )
                )
              ),
              EventBatchingCondition = list(
                BatchSize = 123,
                BatchWindow = 123
              )
            )
          ),
          JobDetails = list(
            JobRuns = list(
              list(
                Id = "string",
                Attempt = 123,
                PreviousRunId = "string",
                TriggerName = "string",
                JobName = "string",
                JobMode = "SCRIPT"|"VISUAL"|"NOTEBOOK",
                JobRunQueuingEnabled = TRUE|FALSE,
                StartedOn = as.POSIXct(
                  "2015-01-01"
                ),
                LastModifiedOn = as.POSIXct(
                  "2015-01-01"
                ),
                CompletedOn = as.POSIXct(
                  "2015-01-01"
                ),
                JobRunState = "STARTING"|"RUNNING"|"STOPPING"|"STOPPED"|"SUCCEEDED"|"FAILED"|"TIMEOUT"|"ERROR"|"WAITING"|"EXPIRED",
                Arguments = list(
                  "string"
                ),
                ErrorMessage = "string",
                PredecessorRuns = list(
                  list(
                    JobName = "string",
                    RunId = "string"
                  )
                ),
                AllocatedCapacity = 123,
                ExecutionTime = 123,
                Timeout = 123,
                MaxCapacity = 123.0,
                WorkerType = "Standard"|"G.1X"|"G.2X"|"G.025X"|"G.4X"|"G.8X"|"Z.2X",
                NumberOfWorkers = 123,
                SecurityConfiguration = "string",
                LogGroupName = "string",
                NotificationProperty = list(
                  NotifyDelayAfter = 123
                ),
                GlueVersion = "string",
                DPUSeconds = 123.0,
                ExecutionClass = "FLEX"|"STANDARD",
                MaintenanceWindow = "string",
                ProfileName = "string",
                StateDetail = "string"
              )
            )
          ),
          CrawlerDetails = list(
            Crawls = list(
              list(
                State = "RUNNING"|"CANCELLING"|"CANCELLED"|"SUCCEEDED"|"FAILED"|"ERROR",
                StartedOn = as.POSIXct(
                  "2015-01-01"
                ),
                CompletedOn = as.POSIXct(
                  "2015-01-01"
                ),
                ErrorMessage = "string",
                LogGroup = "string",
                LogStream = "string"
              )
            )
          )
        )
      ),
      Edges = list(
        list(
          SourceId = "string",
          DestinationId = "string"
        )
      )
    ),
    StartingEventBatchCondition = list(
      BatchSize = 123,
      BatchWindow = 123
    )
  )
)

Request syntax

svc$get_workflow_run(
  Name = "string",
  RunId = "string",
  IncludeGraph = TRUE|FALSE
)