ssm_describe_automation_step_executions: Information about all active and terminated step executions...

Description Usage Arguments Value Request syntax

View source: R/ssm_operations.R

Description

Information about all active and terminated step executions in an Automation workflow.

Usage

1
2
ssm_describe_automation_step_executions(AutomationExecutionId, Filters,
  NextToken, MaxResults, ReverseOrder)

Arguments

AutomationExecutionId

[required] The Automation execution ID for which you want step execution descriptions.

Filters

One or more filters to limit the number of step executions returned by the request.

NextToken

The token for the next set of items to return. (You received this token from a previous call.)

MaxResults

The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

ReverseOrder

A boolean that indicates whether to list step executions in reverse order by start time. The default value is false.

Value

A list with the following syntax:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
list(
  StepExecutions = list(
    list(
      StepName = "string",
      Action = "string",
      TimeoutSeconds = 123,
      OnFailure = "string",
      MaxAttempts = 123,
      ExecutionStartTime = as.POSIXct(
        "2015-01-01"
      ),
      ExecutionEndTime = as.POSIXct(
        "2015-01-01"
      ),
      StepStatus = "Pending"|"InProgress"|"Waiting"|"Success"|"TimedOut"|"Cancelling"|"Cancelled"|"Failed"|"PendingApproval"|"Approved"|"Rejected"|"Scheduled"|"RunbookInProgress"|"PendingChangeCalendarOverride"|"ChangeCalendarOverrideApproved"|"ChangeCalendarOverrideRejected"|"CompletedWithSuccess"|"CompletedWithFailure",
      ResponseCode = "string",
      Inputs = list(
        "string"
      ),
      Outputs = list(
        list(
          "string"
        )
      ),
      Response = "string",
      FailureMessage = "string",
      FailureDetails = list(
        FailureStage = "string",
        FailureType = "string",
        Details = list(
          list(
            "string"
          )
        )
      ),
      StepExecutionId = "string",
      OverriddenParameters = list(
        list(
          "string"
        )
      ),
      IsEnd = TRUE|FALSE,
      NextStep = "string",
      IsCritical = TRUE|FALSE,
      ValidNextSteps = list(
        "string"
      ),
      Targets = list(
        list(
          Key = "string",
          Values = list(
            "string"
          )
        )
      ),
      TargetLocation = list(
        Accounts = list(
          "string"
        ),
        Regions = list(
          "string"
        ),
        TargetLocationMaxConcurrency = "string",
        TargetLocationMaxErrors = "string",
        ExecutionRoleName = "string"
      )
    )
  ),
  NextToken = "string"
)

Request syntax

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
svc$describe_automation_step_executions(
  AutomationExecutionId = "string",
  Filters = list(
    list(
      Key = "StartTimeBefore"|"StartTimeAfter"|"StepExecutionStatus"|"StepExecutionId"|"StepName"|"Action",
      Values = list(
        "string"
      )
    )
  ),
  NextToken = "string",
  MaxResults = 123,
  ReverseOrder = TRUE|FALSE
)

paws.management documentation built on Aug. 23, 2021, 9:11 a.m.