AWS OpsWorks
API Reference (API Version 2013-02-18)

DescribeStackSummary

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.

Request Syntax

{ "StackId": "string" }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

StackId

The stack ID.

Type: String

Required: Yes

Response Syntax

{ "StackSummary": { "AppsCount": number, "Arn": "string", "InstancesCount": { "Assigning": number, "Booting": number, "ConnectionLost": number, "Deregistering": number, "Online": number, "Pending": number, "Rebooting": number, "Registered": number, "Registering": number, "Requested": number, "RunningSetup": number, "SetupFailed": number, "ShuttingDown": number, "StartFailed": number, "StopFailed": number, "Stopped": number, "Stopping": number, "Terminated": number, "Terminating": number, "Unassigning": number }, "LayersCount": number, "Name": "string", "StackId": "string" } }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

StackSummary

A StackSummary object that contains the results.

Type: StackSummary object

Errors

For information about the errors that are common to all actions, see Common Errors.

ResourceNotFoundException

Indicates that a resource was not found.

HTTP Status Code: 400

ValidationException

Indicates that a request was not valid.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: