Skip to content

Batch Get Workflows

glue_batch_get_workflows R Documentation

Returns a list of resource metadata for a given list of workflow names

Description

Returns a list of resource metadata for a given list of workflow names. After calling the list_workflows operation, you can call this operation to access the data to which you have been granted permissions. This operation supports all IAM permissions, including permission conditions that uses tags.

Usage

glue_batch_get_workflows(Names, IncludeGraph)

Arguments

Names

[required] A list of workflow names, which may be the names returned from the list_workflows operation.

IncludeGraph

Specifies whether to include a graph when returning the workflow resource metadata.

Value

A list with the following syntax:

list(
  Workflows = list(
    list(
      Name = "string",
      Description = "string",
      DefaultRunProperties = list(
        "string"
      ),
      CreatedOn = as.POSIXct(
        "2015-01-01"
      ),
      LastModifiedOn = as.POSIXct(
        "2015-01-01"
      ),
      LastRun = 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
        )
      ),
      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"
          )
        )
      ),
      MaxConcurrentRuns = 123,
      BlueprintDetails = list(
        BlueprintName = "string",
        RunId = "string"
      )
    )
  ),
  MissingWorkflows = list(
    "string"
  )
)

Request syntax

svc$batch_get_workflows(
  Names = list(
    "string"
  ),
  IncludeGraph = TRUE|FALSE
)