Skip to content

Describe Stack Summary

opsworks_describe_stack_summary R Documentation

Describes the number of layers and apps in a specified stack, and the number of instances in each state, such as running_setup or online

Description

Describes the number of layers and apps in a specified stack, and the number of instances in each state, such as running_setup or online.

Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.

Usage

opsworks_describe_stack_summary(StackId)

Arguments

StackId

[required] The stack ID.

Value

A list with the following syntax:

list(
  StackSummary = list(
    StackId = "string",
    Name = "string",
    Arn = "string",
    LayersCount = 123,
    AppsCount = 123,
    InstancesCount = list(
      Assigning = 123,
      Booting = 123,
      ConnectionLost = 123,
      Deregistering = 123,
      Online = 123,
      Pending = 123,
      Rebooting = 123,
      Registered = 123,
      Registering = 123,
      Requested = 123,
      RunningSetup = 123,
      SetupFailed = 123,
      ShuttingDown = 123,
      StartFailed = 123,
      StopFailed = 123,
      Stopped = 123,
      Stopping = 123,
      Terminated = 123,
      Terminating = 123,
      Unassigning = 123
    )
  )
)

Request syntax

svc$describe_stack_summary(
  StackId = "string"
)