Get Automation Execution

ssm_get_automation_execution

R Documentation

Get detailed information about a particular Automation execution

Description

Get detailed information about a particular Automation execution.

Usage

ssm_get_automation_execution(AutomationExecutionId)

Arguments

AutomationExecutionId

[required] The unique identifier for an existing automation execution to examine. The execution ID is returned by StartAutomationExecution when the execution of an Automation runbook is initiated.

Value

A list with the following syntax:

list(
  AutomationExecution = list(
    AutomationExecutionId = "string",
    DocumentName = "string",
    DocumentVersion = "string",
    ExecutionStartTime = as.POSIXct(
      "2015-01-01"
    ),
    ExecutionEndTime = as.POSIXct(
      "2015-01-01"
    ),
    AutomationExecutionStatus = "Pending"|"InProgress"|"Waiting"|"Success"|"TimedOut"|"Cancelling"|"Cancelled"|"Failed"|"PendingApproval"|"Approved"|"Rejected"|"Scheduled"|"RunbookInProgress"|"PendingChangeCalendarOverride"|"ChangeCalendarOverrideApproved"|"ChangeCalendarOverrideRejected"|"CompletedWithSuccess"|"CompletedWithFailure"|"Exited",
    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"|"Exited",
        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",
          TargetLocationAlarmConfiguration = list(
            IgnorePollAlarmFailure = TRUE|FALSE,
            Alarms = list(
              list(
                Name = "string"
              )
            )
          )
        ),
        TriggeredAlarms = list(
          list(
            Name = "string",
            State = "UNKNOWN"|"ALARM"
          )
        ),
        ParentStepDetails = list(
          StepExecutionId = "string",
          StepName = "string",
          Action = "string",
          Iteration = 123,
          IteratorValue = "string"
        )
      )
    ),
    StepExecutionsTruncated = TRUE|FALSE,
    Parameters = list(
      list(
        "string"
      )
    ),
    Outputs = list(
      list(
        "string"
      )
    ),
    FailureMessage = "string",
    Mode = "Auto"|"Interactive",
    ParentAutomationExecutionId = "string",
    ExecutedBy = "string",
    CurrentStepName = "string",
    CurrentAction = "string",
    TargetParameterName = "string",
    Targets = list(
      list(
        Key = "string",
        Values = list(
          "string"
        )
      )
    ),
    TargetMaps = list(
      list(
        list(
          "string"
        )
      )
    ),
    ResolvedTargets = list(
      ParameterValues = list(
        "string"
      ),
      Truncated = TRUE|FALSE
    ),
    MaxConcurrency = "string",
    MaxErrors = "string",
    Target = "string",
    TargetLocations = list(
      list(
        Accounts = list(
          "string"
        ),
        Regions = list(
          "string"
        ),
        TargetLocationMaxConcurrency = "string",
        TargetLocationMaxErrors = "string",
        ExecutionRoleName = "string",
        TargetLocationAlarmConfiguration = list(
          IgnorePollAlarmFailure = TRUE|FALSE,
          Alarms = list(
            list(
              Name = "string"
            )
          )
        )
      )
    ),
    ProgressCounters = list(
      TotalSteps = 123,
      SuccessSteps = 123,
      FailedSteps = 123,
      CancelledSteps = 123,
      TimedOutSteps = 123
    ),
    AlarmConfiguration = list(
      IgnorePollAlarmFailure = TRUE|FALSE,
      Alarms = list(
        list(
          Name = "string"
        )
      )
    ),
    TriggeredAlarms = list(
      list(
        Name = "string",
        State = "UNKNOWN"|"ALARM"
      )
    ),
    AutomationSubtype = "ChangeRequest",
    ScheduledTime = as.POSIXct(
      "2015-01-01"
    ),
    Runbooks = list(
      list(
        DocumentName = "string",
        DocumentVersion = "string",
        Parameters = list(
          list(
            "string"
          )
        ),
        TargetParameterName = "string",
        Targets = list(
          list(
            Key = "string",
            Values = list(
              "string"
            )
          )
        ),
        TargetMaps = list(
          list(
            list(
              "string"
            )
          )
        ),
        MaxConcurrency = "string",
        MaxErrors = "string",
        TargetLocations = list(
          list(
            Accounts = list(
              "string"
            ),
            Regions = list(
              "string"
            ),
            TargetLocationMaxConcurrency = "string",
            TargetLocationMaxErrors = "string",
            ExecutionRoleName = "string",
            TargetLocationAlarmConfiguration = list(
              IgnorePollAlarmFailure = TRUE|FALSE,
              Alarms = list(
                list(
                  Name = "string"
                )
              )
            )
          )
        )
      )
    ),
    OpsItemId = "string",
    AssociationId = "string",
    ChangeRequestName = "string",
    Variables = list(
      list(
        "string"
      )
    )
  )
)

Request syntax

svc$get_automation_execution(
  AutomationExecutionId = "string"
)