OpsWorks.Client.describe_stack_summary(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.describe_stack_summary(
StackId='string'
)
[REQUIRED]
The stack ID.
{
'StackSummary': {
'StackId': 'string',
'Name': 'string',
'Arn': 'string',
'LayersCount': 123,
'AppsCount': 123,
'InstancesCount': {
'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
}
}
}
Response Structure
Contains the response to a DescribeStackSummary request.
A StackSummary object that contains the results.
The stack ID.
The stack name.
The stack's ARN.
The number of layers.
The number of apps.
An InstancesCount object with the number of instances in each status.
The number of instances in the Assigning state.
The number of instances with booting status.
The number of instances with connection_lost status.
The number of instances in the Deregistering state.
The number of instances with online status.
The number of instances with pending status.
The number of instances with rebooting status.
The number of instances in the Registered state.
The number of instances in the Registering state.
The number of instances with requested status.
The number of instances with running_setup status.
The number of instances with setup_failed status.
The number of instances with shutting_down status.
The number of instances with start_failed status.
The number of instances with stop_failed status.
The number of instances with stopped status.
The number of instances with stopping status.
The number of instances with terminated status.
The number of instances with terminating status.
The number of instances in the Unassigning state.
Exceptions
OpsWorks.Client.exceptions.ValidationExceptionOpsWorks.Client.exceptions.ResourceNotFoundException