organization_insights

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

Overview

Name	organization_insights
Type	Resource
Id	aws.devops_guru.organization_insights

Fields

The following fields are returned by SELECT queries:

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

list_organization_insights

Name	Datatype	Description
account_id	string	The ID of the Amazon Web Services account. (pattern: <code>^\d{12}$</code>)
id	string	The ID of the insight summary. (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 insight summary. (pattern: <code>^[\s\S]*$</code>)
organizational_unit_id	string	The ID of the organizational unit. (pattern: <code>^ou-[0-9a-z]{4,32}-[a-z0-9]{8,32}$</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	An array of severity values used to search for insights. For more information, see Understanding insight severities in the Amazon DevOps Guru User Guide. (LOW, MEDIUM, HIGH)
status	string	An array of status values used to search for insights. (ONGOING, CLOSED)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
search_organization_insights	select	region		Returns a list of insights in your organization. You can specify which insights are returned by their start time, one or more statuses (ONGOING, CLOSED, and 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.
list_organization_insights	select	region		Returns a list of insights associated with the account or OU Id.

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
region	string	AWS region (default: us-east-1)

SELECT examples

search_organization_insights

Returns a list of insights in your organization. You can specify which insights are returned by their start time, one or more statuses (ONGOING, CLOSED, and 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.organization_insights
WHERE region = '{{ region }}' -- required
;

list_organization_insights

Returns a list of insights associated with the account or OU Id.

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