Skip to content
AWS for Query.Farm

aws.devops_guru.describe_organization_resource_collection_health

Example SQL Queries

SELECT * FROM
aws.devops_guru.describe_organization_resource_collection_health
WHERE
"organization_resource_collection_type" = 'VALUE';

Description

Provides an overview of your system's health. If additional member accounts are part of your organization, you can filter those accounts using the AccountIds field.

Table Definition

Column NameColumn Data Type
organization_resource_collection_type Required Input Column

An Amazon Web Services resource collection type. This type specifies how analyzed Amazon Web Services resources are defined. The two types of Amazon Web Services resource collections supported are Amazon Web Services CloudFormation stacks and Amazon Web Services resources that contain the same Amazon Web Services tag. DevOps Guru can be configured to analyze the Amazon Web Services resources that are defined in the stacks or that are tagged using the same tag key. You can specify up to 500 Amazon Web Services CloudFormation stacks. 

VARCHAR
account_ids Input Column

The ID of the Amazon Web Services account.

VARCHAR[]
Show child fields
account_ids[]
max_results Input Column

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

BIGINT
organizational_unit_ids Input Column

The ID of the organizational unit.

VARCHAR[]
Show child fields
organizational_unit_ids[]
_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
account

The name of the organization's account.

STRUCT(
    "account_id" VARCHAR,
    "insight" STRUCT(
        "open_proactive_insights" BIGINT,
        "open_reactive_insights" BIGINT
    )
)[]
Show child fields
account[]
Show child fields
account[].account_id

The ID of the Amazon Web Services account.

account[].insight

Information about the health of the Amazon Web Services resources in your account, including the number of open proactive, open reactive insights, and the Mean Time to Recover (MTTR) of closed insights.

Show child fields
account[].insight.open_proactive_insights

An integer that specifies the number of open proactive insights in your Amazon Web Services account.

account[].insight.open_reactive_insights

An integer that specifies the number of open reactive insights in your Amazon Web Services account.

cloud_formation

The returned CloudFormationHealthOverview object that contains an InsightHealthOverview object with the requested system health information.

STRUCT(
    "stack_name" VARCHAR,
    "insight" STRUCT(
        "open_proactive_insights" BIGINT,
        "open_reactive_insights" BIGINT,
        "mean_time_to_recover_in_milliseconds" BIGINT
    ),
    "analyzed_resource_count" BIGINT
)[]
Show child fields
cloud_formation[]
Show child fields
cloud_formation[].analyzed_resource_count

Number of resources that DevOps Guru is monitoring in your account that are specified by an Amazon Web Services CloudFormation stack.

cloud_formation[].insight

Information about the health of the Amazon Web Services resources in your account that are specified by an Amazon Web Services CloudFormation stack, including the number of open proactive, open reactive insights, and the Mean Time to Recover (MTTR) of closed insights.

Show child fields
cloud_formation[].insight.mean_time_to_recover_in_milliseconds

The Meant Time to Recover (MTTR) for the insight.

cloud_formation[].insight.open_proactive_insights

The number of open proactive insights.

cloud_formation[].insight.open_reactive_insights

The number of open reactive insights.

cloud_formation[].stack_name

The name of the CloudFormation stack.

service

An array of ServiceHealth objects that describes the health of the Amazon Web Services services associated with the resources in the collection.

STRUCT(
    "service_name" VARCHAR,
    "insight" STRUCT(
        "open_proactive_insights" BIGINT,
        "open_reactive_insights" BIGINT
    ),
    "analyzed_resource_count" BIGINT
)[]
Show child fields
service[]
Show child fields
service[].analyzed_resource_count

Number of resources that DevOps Guru is monitoring in an analyzed Amazon Web Services service.

service[].insight

Represents the health of an Amazon Web Services service. This is a ServiceInsightHealth that contains the number of open proactive and reactive insights for this service.

Show child fields
service[].insight.open_proactive_insights

The number of open proactive insights in the Amazon Web Services service

service[].insight.open_reactive_insights

The number of open reactive insights in the Amazon Web Services service

service[].service_name

The name of the Amazon Web Services service.

tags

Tags help you identify and organize your Amazon Web Services resources. Many Amazon Web Services services support tagging, so you can assign the same tag to resources from different services to indicate that the resources are related. For example, you can assign the same tag to an Amazon DynamoDB table resource that you assign to an Lambda function. For more information about using tags, see the Tagging best practices whitepaper.

Each Amazon Web Services tag has two parts.

  • A tag key (for example, CostCenter, Environment, Project, or Secret). Tag keys are case-sensitive.

  • An optional field known as a tag value (for example, 111122223333, Production, or a team name). Omitting the tag value is the same as using an empty string. Like tag keys, tag values are case-sensitive.

Together these are known as key-value pairs.

The string used for a key in a tag that you use to define your resource coverage must begin with the prefix Devops-guru-. The tag key might be DevOps-Guru-deployment-application or devops-guru-rds-application. When you create a key, the case of characters in the key can be whatever you choose. After you create a key, it is case-sensitive. For example, DevOps Guru works with a key named devops-guru-rds and a key named DevOps-Guru-RDS, and these act as two different keys. Possible key/value pairs in your application might be Devops-Guru-production-application/RDS or Devops-Guru-production-application/containers.

STRUCT(
    "app_boundary_key" VARCHAR,
    "tag_value" VARCHAR,
    "insight" STRUCT(
        "open_proactive_insights" BIGINT,
        "open_reactive_insights" BIGINT,
        "mean_time_to_recover_in_milliseconds" BIGINT
    ),
    "analyzed_resource_count" BIGINT
)[]
Show child fields
tags[]
Show child fields
tags[].analyzed_resource_count

Number of resources that DevOps Guru is monitoring in your account that are specified by an Amazon Web Services tag.

tags[].app_boundary_key

An Amazon Web Services tag key that is used to identify the Amazon Web Services resources that DevOps Guru analyzes. All Amazon Web Services resources in your account and Region tagged with this key make up your DevOps Guru application and analysis boundary.

The string used for a key in a tag that you use to define your resource coverage must begin with the prefix Devops-guru-. The tag key might be DevOps-Guru-deployment-application or devops-guru-rds-application. When you create a key, the case of characters in the key can be whatever you choose. After you create a key, it is case-sensitive. For example, DevOps Guru works with a key named devops-guru-rds and a key named DevOps-Guru-RDS, and these act as two different keys. Possible key/value pairs in your application might be Devops-Guru-production-application/RDS or Devops-Guru-production-application/containers.

tags[].insight

Information about the health of the Amazon Web Services resources in your account that are specified by an Amazon Web Services tag, including the number of open proactive, open reactive insights, and the Mean Time to Recover (MTTR) of closed insights.

Show child fields
tags[].insight.mean_time_to_recover_in_milliseconds

The Meant Time to Recover (MTTR) for the insight.

tags[].insight.open_proactive_insights

The number of open proactive insights.

tags[].insight.open_reactive_insights

The number of open reactive insights.

tags[].tag_value

The value in an Amazon Web Services tag.

The tag's value is an optional field used to associate a string with the tag key (for example, 111122223333, Production, or a team name). The key and value are the tag's key pair. Omitting the tag value is the same as using an empty string. Like tag keys, tag values are case-sensitive. You can specify a maximum of 256 characters for a tag value.