NotificationChannelConfig
Information about notification channels you have configured with DevOps Guru. The one supported notification channel is Amazon Simple Notification Service (Amazon SNS).
Contents
Sns
Information about a notification channel configured in DevOps Guru to send notifications when insights are created.
If you use an Amazon SNS topic in another account, you must attach a policy to it that grants DevOps Guru permission to it notifications. DevOps Guru adds the required policy on your behalf to send notifications using Amazon SNS in your account. For more information, see Permissions for cross account Amazon SNS topics.
If you use an Amazon SNS topic that is encrypted by an AWS Key Management Service customer-managed key (CMK), then you must add permissions to the CMK. For more information, see Permissions for AWS KMS–encrypted Amazon SNS topics.
Type: SnsChannelConfig (p. 192) object Required: Yes
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
OpsCenterIntegration
OpsCenterIntegration
Information about whether DevOps Guru is configured to create an OpsItem in AWS Systems Manager OpsCenter for each created insight.
Contents
OptInStatus
Specifies if DevOps Guru is enabled to create an AWS Systems Manager OpsItem for each created insight.
Type: String
Valid Values: ENABLED | DISABLED Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
OpsCenterIntegrationConfig
OpsCenterIntegrationConfig
Information about whether DevOps Guru is configured to create an OpsItem in AWS Systems Manager OpsCenter for each created insight.
Contents
OptInStatus
Specifies if DevOps Guru is enabled to create an AWS Systems Manager OpsItem for each created insight.
Type: String
Valid Values: ENABLED | DISABLED Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
PerformanceInsightsMetricDimensionGroup
PerformanceInsightsMetricDimensionGroup
A logical grouping of Performance Insights metrics for a related subject area. For example, the db.sql dimension group consists of the following dimensions: db.sql.id, db.sql.db_id, db.sql.statement, and db.sql.tokenized_id.
NoteEach response element returns a maximum of 500 bytes. For larger elements, such as SQL statements, only the first 500 bytes are returned.
Amazon RDS Performance Insights enables you to monitor and explore different dimensions of database load based on data captured from a running DB instance. DB load is measured as average active sessions.
Performance Insights provides the data to API consumers as a two-dimensional time-series dataset. The time dimension provides DB load data for each time point in the queried time range. Each time point decomposes overall load in relation to the requested dimensions, measured at that time point. Examples include SQL, Wait event, User, and Host.
• To learn more about Performance Insights and Amazon Aurora DB instances, go to the Amazon Aurora User Guide.
• To learn more about Performance Insights and Amazon RDS DB instances, go to the Amazon RDS User Guide.
Contents
Dimensions
A list of specific dimensions from a dimension group. If this parameter is not present, then it signifies that all of the dimensions in the group were requested or are present in the response.
Valid values for elements in the Dimensions array are:
• db.application.name - The name of the application that is connected to the database (only Aurora PostgreSQL and RDS PostgreSQL)
• db.host.id - The host ID of the connected client (all engines)
• db.host.name - The host name of the connected client (all engines)
• db.name - The name of the database to which the client is connected (only Aurora PostgreSQL, Amazon RDS PostgreSQL, Aurora MySQL, Amazon RDS MySQL, and MariaDB)
• db.session_type.name - The type of the current session (only Aurora PostgreSQL and RDS PostgreSQL)
• db.sql.id - The SQL ID generated by Performance Insights (all engines)
• db.sql.db_id - The SQL ID generated by the database (all engines)
• db.sql.statement - The SQL text that is being executed (all engines)
• db.sql.tokenized_id
• db.sql_tokenized.id - The SQL digest ID generated by Performance Insights (all engines)
• db.sql_tokenized.db_id - SQL digest ID generated by the database (all engines)
• db.sql_tokenized.statement - The SQL digest text (all engines)
• db.user.id - The ID of the user logged in to the database (all engines)
• db.user.name - The name of the user logged in to the database (all engines)
• db.wait_event.name - The event for which the backend is waiting (all engines)
• db.wait_event.type - The type of event for which the backend is waiting (all engines)
• db.wait_event_type.name - The name of the event type for which the backend is waiting (all engines)
See Also
Type: Array of strings Required: No
Group
The name of the dimension group. Its valid values are:
• db - The name of the database to which the client is connected (only Aurora PostgreSQL, Amazon RDS PostgreSQL, Aurora MySQL, Amazon RDS MySQL, and MariaDB)
• db.application - The name of the application that is connected to the database (only Aurora PostgreSQL and RDS PostgreSQL)
• db.host - The host name of the connected client (all engines)
• db.session_type - The type of the current session (only Aurora PostgreSQL and RDS PostgreSQL)
• db.sql - The SQL that is currently executing (all engines)
• db.sql_tokenized - The SQL digest (all engines)
• db.wait_event - The event for which the database backend is waiting (all engines)
• db.wait_event_type - The type of event for which the database backend is waiting (all engines)
• db.user - The user logged in to the database (all engines) Type: String
Required: No Limit
The maximum number of items to fetch for this dimension group.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 10.
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
PerformanceInsightsMetricQuery
PerformanceInsightsMetricQuery
A single query to be processed. Use these parameters to query the Performance Insights GetResourceMetrics API to retrieve the metrics for an anomaly. For more information, see GetResourceMetrics in the Amazon RDS Performance Insights API Reference.
Amazon RDS Performance Insights enables you to monitor and explore different dimensions of database load based on data captured from a running DB instance. DB load is measured as average active sessions.
Performance Insights provides the data to API consumers as a two-dimensional time-series dataset. The time dimension provides DB load data for each time point in the queried time range. Each time point decomposes overall load in relation to the requested dimensions, measured at that time point. Examples include SQL, Wait event, User, and Host.
• To learn more about Performance Insights and Amazon Aurora DB instances, go to the Amazon Aurora User Guide.
• To learn more about Performance Insights and Amazon RDS DB instances, go to the Amazon RDS User Guide.
Contents
Filter
One or more filters to apply to a Performance Insights GetResourceMetrics API query.
Restrictions:
• Any number of filters by the same dimension, as specified in the GroupBy parameter.
• A single filter for any other dimension in this dimension group.
Type: String to string map Required: No
GroupBy
The specification for how to aggregate the data points from a Performance Insights
GetResourceMetrics API query. The Performance Insights query returns all of the dimensions within that group, unless you provide the names of specific dimensions within that group. You can also request that Performance Insights return a limited number of values for a dimension.
Type: PerformanceInsightsMetricDimensionGroup (p. 136) object Required: No
Metric
The name of the meteric used used when querying an Performance Insights GetResourceMetrics API for anomaly metrics.
Valid values for Metric are:
• db.load.avg - a scaled representation of the number of active sessions for the database engine.
• db.sampledload.avg - the raw number of active sessions for the database engine.
If the number of active sessions is less than an internal Performance Insights threshold,
db.load.avg and db.sampledload.avg are the same value. If the number of active sessions is greater than the internal threshold, Performance Insights samples the active sessions, with db.load.avg showing the scaled values, db.sampledload.avg showing the raw values, and db.sampledload.avg less than db.load.avg. For most use cases, you can query db.load.avg only.
See Also
Type: String Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
PerformanceInsightsMetricsDetail
PerformanceInsightsMetricsDetail
Details about Performance Insights metrics.
Amazon RDS Performance Insights enables you to monitor and explore different dimensions of database load based on data captured from a running DB instance. DB load is measured as average active sessions.
Performance Insights provides the data to API consumers as a two-dimensional time-series dataset. The time dimension provides DB load data for each time point in the queried time range. Each time point decomposes overall load in relation to the requested dimensions, measured at that time point. Examples include SQL, Wait event, User, and Host.
• To learn more about Performance Insights and Amazon Aurora DB instances, go to the Amazon Aurora User Guide.
• To learn more about Performance Insights and Amazon RDS DB instances, go to the Amazon RDS User Guide.
Contents
MetricDisplayName
The name used for a specific Performance Insights metric.
Type: String Required: No MetricQuery
A single query to be processed for the metric. For more information, see PerformanceInsightsMetricQuery .
Type: PerformanceInsightsMetricQuery (p. 138) object Required: No
ReferenceData
For more information, see PerformanceInsightsReferenceData . Type: Array of PerformanceInsightsReferenceData (p. 143) objects Required: No
StatsAtAnomaly
The metric statistics during the anomalous period detected by DevOps Guru;
Type: Array of PerformanceInsightsStat (p. 146) objects Required: No
StatsAtBaseline
Typical metric statistics that are not considered anomalous. When DevOps Guru analyzes metrics, it compares them to StatsAtBaseline to help determine if they are anomalous.
Type: Array of PerformanceInsightsStat (p. 146) objects Required: No
See Also
Unit
The unit of measure for a metric. For example, a session or a process.
Type: String Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
PerformanceInsightsReferenceComparisonValues
PerformanceInsightsReferenceComparisonValues
Reference scalar values and other metrics that DevOps Guru displays on a graph in its console along with the actual metrics it analyzed. Compare these reference values to your actual metrics to help you understand anomalous behavior that DevOps Guru detected.
Contents
ReferenceMetric
A metric that DevOps Guru compares to actual metric values. This reference metric is used to determine if an actual metric should be considered anomalous.
Type: PerformanceInsightsReferenceMetric (p. 144) object Required: No
ReferenceScalar
A scalar value DevOps Guru for a metric that DevOps Guru compares to actual metric values. This reference value is used to determine if an actual metric value should be considered anomalous.
Type: PerformanceInsightsReferenceScalar (p. 145) object Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
PerformanceInsightsReferenceData
PerformanceInsightsReferenceData
Reference data used to evaluate Performance Insights to determine if its performance is anomalous or not.
Contents
ComparisonValues
The specific reference values used to evaluate the Performance Insights. For more information, see PerformanceInsightsReferenceComparisonValues .
Type: PerformanceInsightsReferenceComparisonValues (p. 142) object Required: No
Name
The name of the reference data.
Type: String Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
PerformanceInsightsReferenceMetric
PerformanceInsightsReferenceMetric
Information about a reference metric used to evaluate Performance Insights.
Contents
MetricQuery
A query to be processed on the metric.
Type: PerformanceInsightsMetricQuery (p. 138) object Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
PerformanceInsightsReferenceScalar
PerformanceInsightsReferenceScalar
A reference value to compare Performance Insights metrics against to determine if the metrics demonstrate anomalous behavior.
Contents
Value
The reference value.
Type: Double Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
PerformanceInsightsStat
PerformanceInsightsStat
A statistic in a Performance Insights collection.
Contents
Type
The statistic type.
Type: String Required: No Value
The value of the statistic.
Type: Double Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
PredictionTimeRange
PredictionTimeRange
The time range during which anomalous behavior in a proactive anomaly or an insight is expected to occur.
Contents
EndTime
The time when the behavior in a proactive insight is expected to end.
Type: Timestamp Required: No StartTime
The time range during which a metric limit is expected to be exceeded. This applies to proactive insights only.
Type: Timestamp Required: Yes
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
ProactiveAnomaly
ProactiveAnomaly
Information about an anomaly. This object is returned by ListAnomalies.
Contents
AnomalyReportedTimeRange
An AnomalyReportedTimeRange object that specifies the time range between when the anomaly is opened and the time when it is closed.
Type: AnomalyReportedTimeRange (p. 101) object Required: No
AnomalyResources
Information about a resource in which DevOps Guru detected anomalous behavior.
Type: Array of AnomalyResource (p. 102) objects Required: No
AnomalyTimeRange
A time range that specifies when the observed unusual behavior in an anomaly started and ended.
This is different from AnomalyReportedTimeRange, which specifies the time range when DevOps Guru opens and then closes an anomaly.
Type: AnomalyTimeRange (p. 105) object Required: No
AssociatedInsightId
The ID of the insight that contains this anomaly. An insight is composed of related anomalies.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: ^[\w-]*$
Required: No Id
The ID of a proactive anomaly.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: ^[\w~.-]*$
Required: No Limit
A threshold that was exceeded by behavior in analyzed resources. Exceeding this threshold is related to the anomalous behavior that generated this anomaly.
Type: Double
Contents
Required: No PredictionTimeRange
The time range during which anomalous behavior in a proactive anomaly or an insight is expected to occur.
Type: PredictionTimeRange (p. 147) object Required: No
ResourceCollection
A collection of AWS resources supported by DevOps Guru. The two types of AWS resource collections supported are AWS CloudFormation stacks and AWS resources that contain the same AWS tag.
DevOps Guru can be configured to analyze the AWS resources that are defined in the stacks or that are tagged using the same tag key. You can specify up to 500 AWS CloudFormation stacks.
Type: ResourceCollection (p. 180) object Required: No
Severity
The severity of the anomaly. The severity of anomalies that generate an insight determine that insight's severity. For more information, see Understanding insight severities in the Amazon DevOps Guru User Guide.
Type: String
Valid Values: LOW | MEDIUM | HIGH Required: No
SourceDetails
Details about the source of the analyzed operational data that triggered the anomaly. The one supported source is Amazon CloudWatch metrics.
Type: AnomalySourceDetails (p. 103) object Required: No
SourceMetadata
The metadata for the anomaly.
Type: AnomalySourceMetadata (p. 104) object Required: No
Status
The status of a proactive anomaly.
Type: String
Valid Values: ONGOING | CLOSED Required: No
UpdateTime
The time of the anomaly's most recent update.
Type: Timestamp
See Also
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
ProactiveAnomalySummary
ProactiveAnomalySummary
Details about a proactive anomaly. This object is returned by DescribeAnomaly.
Contents
AnomalyReportedTimeRange
An AnomalyReportedTimeRange object that specifies the time range between when the anomaly is opened and the time when it is closed.
Type: AnomalyReportedTimeRange (p. 101) object Required: No
AnomalyResources
Information about a resource in which DevOps Guru detected anomalous behavior.
Type: Array of AnomalyResource (p. 102) objects Required: No
AnomalyTimeRange
A time range that specifies when the observed unusual behavior in an anomaly started and ended.
This is different from AnomalyReportedTimeRange, which specifies the time range when DevOps Guru opens and then closes an anomaly.
Type: AnomalyTimeRange (p. 105) object Required: No
AssociatedInsightId
The ID of the insight that contains this anomaly. An insight is composed of related anomalies.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: ^[\w-]*$
Required: No Id
The ID of the anomaly.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: ^[\w~.-]*$
Required: No Limit
A threshold that was exceeded by behavior in analyzed resources. Exceeding this threshold is related to the anomalous behavior that generated this anomaly.
Type: Double
Contents
Required: No PredictionTimeRange
The time range during which anomalous behavior in a proactive anomaly or an insight is expected to occur.
Type: PredictionTimeRange (p. 147) object Required: No
ResourceCollection
A collection of AWS resources supported by DevOps Guru. The two types of AWS resource collections supported are AWS CloudFormation stacks and AWS resources that contain the same AWS tag.
DevOps Guru can be configured to analyze the AWS resources that are defined in the stacks or that are tagged using the same tag key. You can specify up to 500 AWS CloudFormation stacks.
Type: ResourceCollection (p. 180) object Required: No
Severity
The severity of the anomaly. The severity of anomalies that generate an insight determine that insight's severity. For more information, see Understanding insight severities in the Amazon DevOps Guru User Guide.
Type: String
Valid Values: LOW | MEDIUM | HIGH Required: No
SourceDetails
Details about the source of the analyzed operational data that triggered the anomaly. The one supported source is Amazon CloudWatch metrics.
Type: AnomalySourceDetails (p. 103) object Required: No
SourceMetadata
The metadata of the source which detects proactive anomalies.
Type: AnomalySourceMetadata (p. 104) object Required: No
Status
The status of the anomaly.
Type: String
Valid Values: ONGOING | CLOSED Required: No
UpdateTime
The time of the anomaly's most recent update.
Type: Timestamp
See Also
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3