insights

Creates, updates, deletes, gets or lists an insights resource.

Overview

Name	insights
Type	Resource
Id	aws.devops_guru.insights

Fields

The following fields are returned by SELECT queries:

search_insights

Name	Datatype	Description
associated_resource_arns	array	The Amazon Resource Names (ARNs) of the Amazon Web Services resources that generated this insight.
id	string	The ID of the proactive insight. (pattern: <code>^[\w-]*$</code>)
insight_time_range	object	A time ranged that specifies when the observed behavior in an insight started and ended.
name	string	The name of the proactive insight. (pattern: <code>^[\s\S]*$</code>)
prediction_time_range	object	The time range during which anomalous behavior in a proactive anomaly or an insight is expected to occur.
resource_collection	object	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.
service_collection	object	A collection of the names of Amazon Web Services services.
severity	string	The severity of the insight. For more information, see Understanding insight severities in the Amazon DevOps Guru User Guide. (LOW, MEDIUM, HIGH)
status	string	The status of the proactive insight. (ONGOING, CLOSED)

describe_insight

Name	Datatype	Description
proactive_insight	object	A ProactiveInsight object that represents the requested insight.
reactive_insight	object	A ReactiveInsight object that represents the requested insight.

list_insights

Name	Datatype	Description
associated_resource_arns	array	The Amazon Resource Names (ARNs) of the Amazon Web Services resources that generated this insight.
id	string	The ID of the proactive insight. (pattern: <code>^[\w-]*$</code>)
insight_time_range	object	A time ranged that specifies when the observed behavior in an insight started and ended.
name	string	The name of the proactive insight. (pattern: <code>^[\s\S]*$</code>)
prediction_time_range	object	The time range during which anomalous behavior in a proactive anomaly or an insight is expected to occur.
resource_collection	object	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.
service_collection	object	A collection of the names of Amazon Web Services services.
severity	string	The severity of the insight. For more information, see Understanding insight severities in the Amazon DevOps Guru User Guide. (LOW, MEDIUM, HIGH)
status	string	The status of the proactive insight. (ONGOING, CLOSED)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
search_insights	select	region		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.
describe_insight	select	id, region	AccountId	Returns details about an insight that you specify using its ID.
list_insights	select	region		Returns a list of insights in your Amazon Web Services account. You can specify which insights are returned by their start time and status (ONGOING, CLOSED, or ANY).
delete_insight	delete	id, region		Deletes the insight along with the associated anomalies, events and recommendations.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
id	string	The ID of the insight.
region	string	AWS region (default: us-east-1)
AccountId	string	The ID of the member account in the organization.

SELECT examples

search_insights

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.

SELECT
associated_resource_arns,
id,
insight_time_range,
name,
prediction_time_range,
resource_collection,
service_collection,
severity,
status
FROM aws.devops_guru.insights
WHERE region = '{{ region }}' -- required
;

describe_insight

Returns details about an insight that you specify using its ID.

SELECT
proactive_insight,
reactive_insight
FROM aws.devops_guru.insights
WHERE id = '{{ id }}' -- required
AND region = '{{ region }}' -- required
AND AccountId = '{{ AccountId }}'
;

list_insights

Returns a list of insights in your Amazon Web Services account. You can specify which insights are returned by their start time and status (ONGOING, CLOSED, or ANY).

SELECT
associated_resource_arns,
id,
insight_time_range,
name,
prediction_time_range,
resource_collection,
service_collection,
severity,
status
FROM aws.devops_guru.insights
WHERE region = '{{ region }}' -- required
;

DELETE examples

delete_insight

Deletes the insight along with the associated anomalies, events and recommendations.

DELETE FROM aws.devops_guru.insights
WHERE id = '{{ id }}' --required
AND region = '{{ region }}' --required
;