Skip to content

Describe Stack Set Operation

cloudformation_describe_stack_set_operation R Documentation

Returns the description of the specified StackSet operation

Description

Returns the description of the specified StackSet operation.

This API provides strongly consistent reads meaning it will always return the most up-to-date data.

Usage

cloudformation_describe_stack_set_operation(StackSetName, OperationId,
  CallAs)

Arguments

StackSetName

[required] The name or the unique stack ID of the StackSet for the stack operation.

OperationId

[required] The unique ID of the StackSet operation.

CallAs

[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.

By default, SELF is specified. Use SELF for StackSets with self-managed permissions.

  • If you are signed in to the management account, specify SELF.

  • If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.

    Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.

Value

A list with the following syntax:

list(
  StackSetOperation = list(
    OperationId = "string",
    StackSetId = "string",
    Action = "CREATE"|"UPDATE"|"DELETE"|"DETECT_DRIFT",
    Status = "RUNNING"|"SUCCEEDED"|"FAILED"|"STOPPING"|"STOPPED"|"QUEUED",
    OperationPreferences = list(
      RegionConcurrencyType = "SEQUENTIAL"|"PARALLEL",
      RegionOrder = list(
        "string"
      ),
      FailureToleranceCount = 123,
      FailureTolerancePercentage = 123,
      MaxConcurrentCount = 123,
      MaxConcurrentPercentage = 123,
      ConcurrencyMode = "STRICT_FAILURE_TOLERANCE"|"SOFT_FAILURE_TOLERANCE"
    ),
    RetainStacks = TRUE|FALSE,
    AdministrationRoleARN = "string",
    ExecutionRoleName = "string",
    CreationTimestamp = as.POSIXct(
      "2015-01-01"
    ),
    EndTimestamp = as.POSIXct(
      "2015-01-01"
    ),
    DeploymentTargets = list(
      Accounts = list(
        "string"
      ),
      AccountsUrl = "string",
      OrganizationalUnitIds = list(
        "string"
      ),
      AccountFilterType = "NONE"|"INTERSECTION"|"DIFFERENCE"|"UNION"
    ),
    StackSetDriftDetectionDetails = list(
      DriftStatus = "DRIFTED"|"IN_SYNC"|"NOT_CHECKED",
      DriftDetectionStatus = "COMPLETED"|"FAILED"|"PARTIAL_SUCCESS"|"IN_PROGRESS"|"STOPPED",
      LastDriftCheckTimestamp = as.POSIXct(
        "2015-01-01"
      ),
      TotalStackInstancesCount = 123,
      DriftedStackInstancesCount = 123,
      InSyncStackInstancesCount = 123,
      InProgressStackInstancesCount = 123,
      FailedStackInstancesCount = 123
    ),
    StatusReason = "string",
    StatusDetails = list(
      FailedStackInstancesCount = 123
    )
  )
)

Request syntax

svc$describe_stack_set_operation(
  StackSetName = "string",
  OperationId = "string",
  CallAs = "SELF"|"DELEGATED_ADMIN"
)