OpsWorks / Client / describe_stack_summary

describe_stack_summary

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'
)

Parameters:

StackId (string) –

[REQUIRED]

The stack ID.

Return type:

dict

Returns:

Response Syntax

{
    '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

• (dict) –

  Contains the response to a DescribeStackSummary request.

  • StackSummary (dict) –

    A StackSummary object that contains the results.

    • StackId (string) –

      The stack ID.

    • Name (string) –

      The stack name.

    • Arn (string) –

      The stack’s ARN.

    • LayersCount (integer) –

      The number of layers.

    • AppsCount (integer) –

      The number of apps.

    • InstancesCount (dict) –

      An InstancesCount object with the number of instances in each status.

      • Assigning (integer) –

        The number of instances in the Assigning state.

      • Booting (integer) –

        The number of instances with booting status.

      • ConnectionLost (integer) –

        The number of instances with connection_lost status.

      • Deregistering (integer) –

        The number of instances in the Deregistering state.

      • Online (integer) –

        The number of instances with online status.

      • Pending (integer) –

        The number of instances with pending status.

      • Rebooting (integer) –

        The number of instances with rebooting status.

      • Registered (integer) –

        The number of instances in the Registered state.

      • Registering (integer) –

        The number of instances in the Registering state.

      • Requested (integer) –

        The number of instances with requested status.

      • RunningSetup (integer) –

        The number of instances with running_setup status.

      • SetupFailed (integer) –

        The number of instances with setup_failed status.

      • ShuttingDown (integer) –

        The number of instances with shutting_down status.

      • StartFailed (integer) –

        The number of instances with start_failed status.

      • StopFailed (integer) –

        The number of instances with stop_failed status.

      • Stopped (integer) –

        The number of instances with stopped status.

      • Stopping (integer) –

        The number of instances with stopping status.

      • Terminated (integer) –

        The number of instances with terminated status.

      • Terminating (integer) –

        The number of instances with terminating status.

      • Unassigning (integer) –

        The number of instances in the Unassigning state.

Exceptions

• OpsWorks.Client.exceptions.ValidationException

• OpsWorks.Client.exceptions.ResourceNotFoundException