Skip to content
AWS for Query.Farm

aws.opsworks.describe_stack_summary

Example SQL Queries

SELECT * FROM
aws.opsworks.describe_stack_summary
WHERE
"stack_id" = 'VALUE';

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.

Table Definition

Column NameColumn Data Type
stack_id Required Input Column

The stack ID.

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
stack_summary

A StackSummary object that contains the results.

STRUCT(
    "stack_id" VARCHAR,
    "name" VARCHAR,
    "arn" VARCHAR,
    "layers_count" BIGINT,
    "apps_count" BIGINT,
    "instances_count" STRUCT(
        "assigning" BIGINT,
        "booting" BIGINT,
        "connection_lost" BIGINT,
        "deregistering" BIGINT,
        "online" BIGINT,
        "pending" BIGINT,
        "rebooting" BIGINT,
        "registered" BIGINT,
        "registering" BIGINT,
        "requested" BIGINT,
        "running_setup" BIGINT,
        "setup_failed" BIGINT,
        "shutting_down" BIGINT,
        "start_failed" BIGINT,
        "stop_failed" BIGINT,
        "stopped" BIGINT,
        "stopping" BIGINT,
        "terminated" BIGINT,
        "terminating" BIGINT,
        "unassigning" BIGINT
    )
)
Show child fields
stack_summary.apps_count

The number of apps.

stack_summary.arn

The stack's ARN.

stack_summary.instances_count

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

Show child fields
stack_summary.instances_count.assigning

The number of instances in the Assigning state.

stack_summary.instances_count.booting

The number of instances with booting status.

stack_summary.instances_count.connection_lost

The number of instances with connection_lost status.

stack_summary.instances_count.deregistering

The number of instances in the Deregistering state.

stack_summary.instances_count.online

The number of instances with online status.

stack_summary.instances_count.pending

The number of instances with pending status.

stack_summary.instances_count.rebooting

The number of instances with rebooting status.

stack_summary.instances_count.registered

The number of instances in the Registered state.

stack_summary.instances_count.registering

The number of instances in the Registering state.

stack_summary.instances_count.requested

The number of instances with requested status.

stack_summary.instances_count.running_setup

The number of instances with running_setup status.

stack_summary.instances_count.setup_failed

The number of instances with setup_failed status.

stack_summary.instances_count.shutting_down

The number of instances with shutting_down status.

stack_summary.instances_count.start_failed

The number of instances with start_failed status.

stack_summary.instances_count.stop_failed

The number of instances with stop_failed status.

stack_summary.instances_count.stopped

The number of instances with stopped status.

stack_summary.instances_count.stopping

The number of instances with stopping status.

stack_summary.instances_count.terminated

The number of instances with terminated status.

stack_summary.instances_count.terminating

The number of instances with terminating status.

stack_summary.instances_count.unassigning

The number of instances in the Unassigning state.

stack_summary.layers_count

The number of layers.

stack_summary.name

The stack name.

stack_summary.stack_id

The stack ID.