Skip to content
AWS for Query.Farm

aws.devops_guru.search_insights

Example SQL Queries

SELECT * FROM
aws.devops_guru.search_insights
WHERE
"start_time_range" = 'VALUE'
AND "type" = 'VALUE';

Description

Returns a list of insights in your Amazon Web Services account. You can specify which insights are returned by their start time, one or more statuses (ONGOING or CLOSED), one or more severities (LOW, MEDIUM, and HIGH), and type (REACTIVE or PROACTIVE).

Use the Filters parameter to specify status and severity search parameters. Use the Type parameter to specify REACTIVE or PROACTIVE in your search.

Table Definition

Column NameColumn Data Type
start_time_range Required Input Column

The start of the time range passed in. Returned insights occurred after this time. 

STRUCT(
    "from_time" TIMESTAMP_S,
    "to_time" TIMESTAMP_S
)
Show child fields
start_time_range.from_time

The start time of the time range.

start_time_range.to_time

The end time of the time range.

type Required Input Column

The type of insights you are searching for (REACTIVE or PROACTIVE). 

VARCHAR
filters Input Column

A SearchInsightsFilters object that is used to set the severity and status filters on your insight search. 

STRUCT(
    "severities" VARCHAR[],
    "statuses" VARCHAR[],
    "resource_collection" STRUCT(
        "cloud_formation" STRUCT(
            "stack_names" VARCHAR[]
        ),
        "tags" STRUCT(
            "app_boundary_key" VARCHAR,
            "tag_values" VARCHAR[]
        )[]
    ),
    "service_collection" STRUCT(
        "service_names" VARCHAR[]
    )
)
Show child fields
filters.resource_collection

A collection of Amazon Web Services resources supported by DevOps Guru. 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.

Show child fields
filters.resource_collection.cloud_formation

An array of the names of Amazon Web Services CloudFormation stacks. The stacks define Amazon Web Services resources that DevOps Guru analyzes. You can specify up to 500 Amazon Web Services CloudFormation stacks.

Show child fields
filters.resource_collection.cloud_formation.stack_names[]
filters.resource_collection.tags[]
Show child fields
filters.resource_collection.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.

filters.resource_collection.tags[].tag_values[]
filters.service_collection

A collection of the names of Amazon Web Services services.

Show child fields
filters.service_collection.service_names[]
filters.severities[]
filters.statuses[]
_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
proactive_insights

The returned proactive insights. 

STRUCT(
    "id" VARCHAR,
    "name" VARCHAR,
    "severity" VARCHAR,
    "status" VARCHAR,
    "insight_time_range" STRUCT(
        "start_time" TIMESTAMP_S,
        "end_time" TIMESTAMP_S
    ),
    "prediction_time_range" STRUCT(
        "start_time" TIMESTAMP_S,
        "end_time" TIMESTAMP_S
    ),
    "resource_collection" STRUCT(
        "cloud_formation" STRUCT(
            "stack_names" VARCHAR[]
        ),
        "tags" STRUCT(
            "app_boundary_key" VARCHAR,
            "tag_values" VARCHAR[]
        )[]
    ),
    "service_collection" STRUCT(
        "service_names" VARCHAR[]
    ),
    "associated_resource_arns" VARCHAR[]
)[]
Show child fields
proactive_insights[]
Show child fields
proactive_insights[].associated_resource_arns[]
proactive_insights[].id

The ID of the proactive insight.

proactive_insights[].insight_time_range

A time ranged that specifies when the observed behavior in an insight started and ended.

Show child fields
proactive_insights[].insight_time_range.end_time

The time when the behavior described in an insight ended.

proactive_insights[].insight_time_range.start_time

The time when the behavior described in an insight started.

proactive_insights[].name

The name of the proactive insight.

proactive_insights[].prediction_time_range

The time range during which anomalous behavior in a proactive anomaly or an insight is expected to occur.

Show child fields
proactive_insights[].prediction_time_range.end_time

The time when the behavior in a proactive insight is expected to end.

proactive_insights[].prediction_time_range.start_time

The time range during which a metric limit is expected to be exceeded. This applies to proactive insights only.

proactive_insights[].resource_collection

A collection of Amazon Web Services resources supported by DevOps Guru. 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.

Show child fields
proactive_insights[].resource_collection.cloud_formation

An array of the names of Amazon Web Services CloudFormation stacks. The stacks define Amazon Web Services resources that DevOps Guru analyzes. You can specify up to 500 Amazon Web Services CloudFormation stacks.

Show child fields
proactive_insights[].resource_collection.cloud_formation.stack_names[]
proactive_insights[].resource_collection.tags[]
Show child fields
proactive_insights[].resource_collection.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.

proactive_insights[].resource_collection.tags[].tag_values[]
proactive_insights[].service_collection

A collection of the names of Amazon Web Services services.

Show child fields
proactive_insights[].service_collection.service_names[]
proactive_insights[].severity

The severity of the insight. For more information, see Understanding insight severities in the Amazon DevOps Guru User Guide.

proactive_insights[].status

The status of the proactive insight.

reactive_insights

The returned reactive insights. 

STRUCT(
    "id" VARCHAR,
    "name" VARCHAR,
    "severity" VARCHAR,
    "status" VARCHAR,
    "insight_time_range" STRUCT(
        "start_time" TIMESTAMP_S,
        "end_time" TIMESTAMP_S
    ),
    "resource_collection" STRUCT(
        "cloud_formation" STRUCT(
            "stack_names" VARCHAR[]
        ),
        "tags" STRUCT(
            "app_boundary_key" VARCHAR,
            "tag_values" VARCHAR[]
        )[]
    ),
    "service_collection" STRUCT(
        "service_names" VARCHAR[]
    ),
    "associated_resource_arns" VARCHAR[]
)[]
Show child fields
reactive_insights[]
Show child fields
reactive_insights[].associated_resource_arns[]
reactive_insights[].id

The ID of a reactive summary.

reactive_insights[].insight_time_range

A time ranged that specifies when the observed behavior in an insight started and ended.

Show child fields
reactive_insights[].insight_time_range.end_time

The time when the behavior described in an insight ended.

reactive_insights[].insight_time_range.start_time

The time when the behavior described in an insight started.

reactive_insights[].name

The name of a reactive insight.

reactive_insights[].resource_collection

A collection of Amazon Web Services resources supported by DevOps Guru. 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.

Show child fields
reactive_insights[].resource_collection.cloud_formation

An array of the names of Amazon Web Services CloudFormation stacks. The stacks define Amazon Web Services resources that DevOps Guru analyzes. You can specify up to 500 Amazon Web Services CloudFormation stacks.

Show child fields
reactive_insights[].resource_collection.cloud_formation.stack_names[]
reactive_insights[].resource_collection.tags[]
Show child fields
reactive_insights[].resource_collection.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.

reactive_insights[].resource_collection.tags[].tag_values[]
reactive_insights[].service_collection

A collection of the names of Amazon Web Services services.

Show child fields
reactive_insights[].service_collection.service_names[]
reactive_insights[].severity

The severity of the insight. For more information, see Understanding insight severities in the Amazon DevOps Guru User Guide.

reactive_insights[].status

The status of a reactive insight.