Skip to content

Get Control Operation

controltower_get_control_operation R Documentation

Returns the status of a particular EnableControl or DisableControl operation

Description

Returns the status of a particular enable_control or disable_control operation. Displays a message in case of error. Details for an operation are available for 90 days. For usage examples, see the Controls Reference Guide .

Usage

controltower_get_control_operation(operationIdentifier)

Arguments

operationIdentifier

[required] The ID of the asynchronous operation, which is used to track status. The operation is available for 90 days.

Value

A list with the following syntax:

list(
  controlOperation = list(
    controlIdentifier = "string",
    enabledControlIdentifier = "string",
    endTime = as.POSIXct(
      "2015-01-01"
    ),
    operationIdentifier = "string",
    operationType = "ENABLE_CONTROL"|"DISABLE_CONTROL"|"UPDATE_ENABLED_CONTROL",
    startTime = as.POSIXct(
      "2015-01-01"
    ),
    status = "SUCCEEDED"|"FAILED"|"IN_PROGRESS",
    statusMessage = "string",
    targetIdentifier = "string"
  )
)

Request syntax

svc$get_control_operation(
  operationIdentifier = "string"
)