2021/12/01 - Amazon DevOps Guru - 14 updated api methods
Changes DevOps Guru now provides detailed, database-specific analyses of performance issues and recommends corrective actions for Amazon Aurora database instances with Performance Insights turned on. You can also use AWS tags to choose which resources to analyze and define your applications.
{'ProactiveAnomaly': {'ResourceCollection': {'Tags': [{'AppBoundaryKey': 'string',
'TagValues': ['string']}]},
'SourceDetails': {'PerformanceInsightsMetrics': [{'MetricDisplayName': 'string',
'MetricQuery': {'Filter': {'string': 'string'},
'GroupBy': {'Dimensions': ['string'],
'Group': 'string',
'Limit': 'integer'},
'Metric': 'string'},
'ReferenceData': [{'ComparisonValues': {'ReferenceMetric': {'MetricQuery': {'Filter': {'string': 'string'},
'GroupBy': {'Dimensions': ['string'],
'Group': 'string',
'Limit': 'integer'},
'Metric': 'string'}},
'ReferenceScalar': {'Value': 'double'}},
'Name': 'string'}],
'StatsAtAnomaly': [{'Type': 'string',
'Value': 'double'}],
'StatsAtBaseline': [{'Type': 'string',
'Value': 'double'}],
'Unit': 'string'}]}},
'ReactiveAnomaly': {'AnomalyResources': [{'Name': 'string', 'Type': 'string'}],
'CausalAnomalyId': 'string',
'Description': 'string',
'Name': 'string',
'ResourceCollection': {'Tags': [{'AppBoundaryKey': 'string',
'TagValues': ['string']}]},
'SourceDetails': {'PerformanceInsightsMetrics': [{'MetricDisplayName': 'string',
'MetricQuery': {'Filter': {'string': 'string'},
'GroupBy': {'Dimensions': ['string'],
'Group': 'string',
'Limit': 'integer'},
'Metric': 'string'},
'ReferenceData': [{'ComparisonValues': {'ReferenceMetric': {'MetricQuery': {'Filter': {'string': 'string'},
'GroupBy': {'Dimensions': ['string'],
'Group': 'string',
'Limit': 'integer'},
'Metric': 'string'}},
'ReferenceScalar': {'Value': 'double'}},
'Name': 'string'}],
'StatsAtAnomaly': [{'Type': 'string',
'Value': 'double'}],
'StatsAtBaseline': [{'Type': 'string',
'Value': 'double'}],
'Unit': 'string'}]},
'Type': 'CAUSAL | CONTEXTUAL'}}
Returns details about an anomaly that you specify using its ID.
See also: AWS API Documentation
Request Syntax
client.describe_anomaly(
Id='string',
AccountId='string'
)
string
[REQUIRED]
The ID of the anomaly.
string
The ID of the member account.
dict
Response Syntax
{
'ProactiveAnomaly': {
'Id': 'string',
'Severity': 'LOW'|'MEDIUM'|'HIGH',
'Status': 'ONGOING'|'CLOSED',
'UpdateTime': datetime(2015, 1, 1),
'AnomalyTimeRange': {
'StartTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1)
},
'AnomalyReportedTimeRange': {
'OpenTime': datetime(2015, 1, 1),
'CloseTime': datetime(2015, 1, 1)
},
'PredictionTimeRange': {
'StartTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1)
},
'SourceDetails': {
'CloudWatchMetrics': [
{
'MetricName': 'string',
'Namespace': 'string',
'Dimensions': [
{
'Name': 'string',
'Value': 'string'
},
],
'Stat': 'Sum'|'Average'|'SampleCount'|'Minimum'|'Maximum'|'p99'|'p90'|'p50',
'Unit': 'string',
'Period': 123,
'MetricDataSummary': {
'TimestampMetricValuePairList': [
{
'Timestamp': datetime(2015, 1, 1),
'MetricValue': 123.0
},
],
'StatusCode': 'Complete'|'InternalError'|'PartialData'
}
},
],
'PerformanceInsightsMetrics': [
{
'MetricDisplayName': 'string',
'Unit': 'string',
'MetricQuery': {
'Metric': 'string',
'GroupBy': {
'Group': 'string',
'Dimensions': [
'string',
],
'Limit': 123
},
'Filter': {
'string': 'string'
}
},
'ReferenceData': [
{
'Name': 'string',
'ComparisonValues': {
'ReferenceScalar': {
'Value': 123.0
},
'ReferenceMetric': {
'MetricQuery': {
'Metric': 'string',
'GroupBy': {
'Group': 'string',
'Dimensions': [
'string',
],
'Limit': 123
},
'Filter': {
'string': 'string'
}
}
}
}
},
],
'StatsAtAnomaly': [
{
'Type': 'string',
'Value': 123.0
},
],
'StatsAtBaseline': [
{
'Type': 'string',
'Value': 123.0
},
]
},
]
},
'AssociatedInsightId': 'string',
'ResourceCollection': {
'CloudFormation': {
'StackNames': [
'string',
]
},
'Tags': [
{
'AppBoundaryKey': 'string',
'TagValues': [
'string',
]
},
]
},
'Limit': 123.0
},
'ReactiveAnomaly': {
'Id': 'string',
'Severity': 'LOW'|'MEDIUM'|'HIGH',
'Status': 'ONGOING'|'CLOSED',
'AnomalyTimeRange': {
'StartTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1)
},
'AnomalyReportedTimeRange': {
'OpenTime': datetime(2015, 1, 1),
'CloseTime': datetime(2015, 1, 1)
},
'SourceDetails': {
'CloudWatchMetrics': [
{
'MetricName': 'string',
'Namespace': 'string',
'Dimensions': [
{
'Name': 'string',
'Value': 'string'
},
],
'Stat': 'Sum'|'Average'|'SampleCount'|'Minimum'|'Maximum'|'p99'|'p90'|'p50',
'Unit': 'string',
'Period': 123,
'MetricDataSummary': {
'TimestampMetricValuePairList': [
{
'Timestamp': datetime(2015, 1, 1),
'MetricValue': 123.0
},
],
'StatusCode': 'Complete'|'InternalError'|'PartialData'
}
},
],
'PerformanceInsightsMetrics': [
{
'MetricDisplayName': 'string',
'Unit': 'string',
'MetricQuery': {
'Metric': 'string',
'GroupBy': {
'Group': 'string',
'Dimensions': [
'string',
],
'Limit': 123
},
'Filter': {
'string': 'string'
}
},
'ReferenceData': [
{
'Name': 'string',
'ComparisonValues': {
'ReferenceScalar': {
'Value': 123.0
},
'ReferenceMetric': {
'MetricQuery': {
'Metric': 'string',
'GroupBy': {
'Group': 'string',
'Dimensions': [
'string',
],
'Limit': 123
},
'Filter': {
'string': 'string'
}
}
}
}
},
],
'StatsAtAnomaly': [
{
'Type': 'string',
'Value': 123.0
},
],
'StatsAtBaseline': [
{
'Type': 'string',
'Value': 123.0
},
]
},
]
},
'AssociatedInsightId': 'string',
'ResourceCollection': {
'CloudFormation': {
'StackNames': [
'string',
]
},
'Tags': [
{
'AppBoundaryKey': 'string',
'TagValues': [
'string',
]
},
]
},
'Type': 'CAUSAL'|'CONTEXTUAL',
'Name': 'string',
'Description': 'string',
'CausalAnomalyId': 'string',
'AnomalyResources': [
{
'Name': 'string',
'Type': 'string'
},
]
}
}
Response Structure
(dict) --
ProactiveAnomaly (dict) --
A ProactiveAnomaly object that represents the requested anomaly.
Id (string) --
The ID of a proactive anomaly.
Severity (string) --
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 .
Status (string) --
The status of a proactive anomaly.
UpdateTime (datetime) --
The time of the anomaly's most recent update.
AnomalyTimeRange (dict) --
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.
StartTime (datetime) --
The time when the anomalous behavior started.
EndTime (datetime) --
The time when the anomalous behavior ended.
AnomalyReportedTimeRange (dict) --
An AnomalyReportedTimeRange object that specifies the time range between when the anomaly is opened and the time when it is closed.
OpenTime (datetime) --
The time when an anomaly is opened.
CloseTime (datetime) --
The time when an anomaly is closed.
PredictionTimeRange (dict) --
The time range during which anomalous behavior in a proactive anomaly or an insight is expected to occur.
StartTime (datetime) --
The time range during which a metric limit is expected to be exceeded. This applies to proactive insights only.
EndTime (datetime) --
The time when the behavior in a proactive insight is expected to end.
SourceDetails (dict) --
Details about the source of the analyzed operational data that triggered the anomaly. The one supported source is Amazon CloudWatch metrics.
CloudWatchMetrics (list) --
An array of CloudWatchMetricsDetail objects that contain information about analyzed CloudWatch metrics that show anomalous behavior.
(dict) --
Information about an Amazon CloudWatch metric.
MetricName (string) --
The name of the CloudWatch metric.
Namespace (string) --
The namespace of the CloudWatch metric. A namespace is a container for CloudWatch metrics.
Dimensions (list) --
An array of CloudWatch dimensions associated with
(dict) --
The dimension of am Amazon CloudWatch metric that is used when DevOps Guru analyzes the resources in your account for operational problems and anomalous behavior. A dimension is a name/value pair that is part of the identity of a metric. A metric can have up to 10 dimensions. For more information, see Dimensions in the Amazon CloudWatch User Guide .
Name (string) --
The name of the CloudWatch dimension.
Value (string) --
The value of the CloudWatch dimension.
Stat (string) --
The type of statistic associated with the CloudWatch metric. For more information, see Statistics in the Amazon CloudWatch User Guide .
Unit (string) --
The unit of measure used for the CloudWatch metric. For example, Bytes , Seconds , Count , and Percent .
Period (integer) --
The length of time associated with the CloudWatch metric in number of seconds.
MetricDataSummary (dict) --
This object returns anomaly metric data.
TimestampMetricValuePairList (list) --
This is a list of Amazon CloudWatch metric values at given timestamp.
(dict) --
A pair that contains metric values at the respective timestamp.
Timestamp (datetime) --
A Timestamp that specifies the time the event occurred.
MetricValue (float) --
Value of the anomalous metric data point at respective Timestamp.
StatusCode (string) --
This is an enum of the status showing whether the metric value pair list has partial or complete data, or if there was an error.
PerformanceInsightsMetrics (list) --
An array of PerformanceInsightsMetricsDetail objects that contain information about analyzed Performance Insights metrics that show anomalous behavior.
(dict) --
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.
MetricDisplayName (string) --
The name used for a specific Performance Insights metric.
Unit (string) --
The unit of measure for a metric. For example, a session or a process.
MetricQuery (dict) --
A single query to be processed for the metric. For more information, see PerformanceInsightsMetricQuery .
Metric (string) --
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.
GroupBy (dict) --
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.
Group (string) --
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)
Dimensions (list) --
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)
(string) --
Limit (integer) --
The maximum number of items to fetch for this dimension group.
Filter (dict) --
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.
(string) --
(string) --
ReferenceData (list) --
For more information, see PerformanceInsightsReferenceData .
(dict) --
Reference data used to evaluate Performance Insights to determine if its performance is anomalous or not.
Name (string) --
The name of the reference data.
ComparisonValues (dict) --
The specific reference values used to evaluate the Performance Insights. For more information, see PerformanceInsightsReferenceComparisonValues .
ReferenceScalar (dict) --
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.
Value (float) --
The reference value.
ReferenceMetric (dict) --
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.
MetricQuery (dict) --
A query to be processed on the metric.
Metric (string) --
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.
GroupBy (dict) --
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.
Group (string) --
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)
Dimensions (list) --
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)
(string) --
Limit (integer) --
The maximum number of items to fetch for this dimension group.
Filter (dict) --
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.
(string) --
(string) --
StatsAtAnomaly (list) --
The metric statistics during the anomalous period detected by DevOps Guru;
(dict) --
A statistic in a Performance Insights collection.
Type (string) --
The statistic type.
Value (float) --
The value of the statistic.
StatsAtBaseline (list) --
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.
(dict) --
A statistic in a Performance Insights collection.
Type (string) --
The statistic type.
Value (float) --
The value of the statistic.
AssociatedInsightId (string) --
The ID of the insight that contains this anomaly. An insight is composed of related anomalies.
ResourceCollection (dict) --
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.
CloudFormation (dict) --
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.
StackNames (list) --
An array of CloudFormation stack names.
(string) --
Tags (list) --
The Amazon Web Services tags that are used by resources in the resource collection.
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.
Warning
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 . While keys are case-sensitive, the case of key characters don't matter to DevOps Guru. For example, DevOps Guru works with a key named devops-guru-rds and a key named DevOps-Guru-RDS . Possible key /value pairs in your application might be Devops-Guru-production-application/RDS or Devops-Guru-production-application/containers .
(dict) --
A collection of Amazon Web Services stags.
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.
Warning
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 . While keys are case-sensitive, the case of key characters don't matter to DevOps Guru. For example, DevOps Guru works with a key named devops-guru-rds and a key named DevOps-Guru-RDS . Possible key /value pairs in your application might be Devops-Guru-production-application/RDS or Devops-Guru-production-application/containers .
AppBoundaryKey (string) --
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.
Warning
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 . While keys are case-sensitive, the case of key characters don't matter to DevOps Guru. For example, DevOps Guru works with a key named devops-guru-rds and a key named DevOps-Guru-RDS . Possible key /value pairs in your application might be Devops-Guru-production-application/RDS or Devops-Guru-production-application/containers .
TagValues (list) --
The values in an Amazon Web Services tag collection.
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.
(string) --
Limit (float) --
A threshold that was exceeded by behavior in analyzed resources. Exceeding this threshold is related to the anomalous behavior that generated this anomaly.
ReactiveAnomaly (dict) --
A ReactiveAnomaly object that represents the requested anomaly.
Id (string) --
The ID of the reactive anomaly.
Severity (string) --
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 .
Status (string) --
The status of the anomaly.
AnomalyTimeRange (dict) --
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.
StartTime (datetime) --
The time when the anomalous behavior started.
EndTime (datetime) --
The time when the anomalous behavior ended.
AnomalyReportedTimeRange (dict) --
An AnomalyReportedTimeRange object that specifies the time range between when the anomaly is opened and the time when it is closed.
OpenTime (datetime) --
The time when an anomaly is opened.
CloseTime (datetime) --
The time when an anomaly is closed.
SourceDetails (dict) --
Details about the source of the analyzed operational data that triggered the anomaly. The one supported source is Amazon CloudWatch metrics.
CloudWatchMetrics (list) --
An array of CloudWatchMetricsDetail objects that contain information about analyzed CloudWatch metrics that show anomalous behavior.
(dict) --
Information about an Amazon CloudWatch metric.
MetricName (string) --
The name of the CloudWatch metric.
Namespace (string) --
The namespace of the CloudWatch metric. A namespace is a container for CloudWatch metrics.
Dimensions (list) --
An array of CloudWatch dimensions associated with
(dict) --
The dimension of am Amazon CloudWatch metric that is used when DevOps Guru analyzes the resources in your account for operational problems and anomalous behavior. A dimension is a name/value pair that is part of the identity of a metric. A metric can have up to 10 dimensions. For more information, see Dimensions in the Amazon CloudWatch User Guide .
Name (string) --
The name of the CloudWatch dimension.
Value (string) --
The value of the CloudWatch dimension.
Stat (string) --
The type of statistic associated with the CloudWatch metric. For more information, see Statistics in the Amazon CloudWatch User Guide .
Unit (string) --
The unit of measure used for the CloudWatch metric. For example, Bytes , Seconds , Count , and Percent .
Period (integer) --
The length of time associated with the CloudWatch metric in number of seconds.
MetricDataSummary (dict) --
This object returns anomaly metric data.
TimestampMetricValuePairList (list) --
This is a list of Amazon CloudWatch metric values at given timestamp.
(dict) --
A pair that contains metric values at the respective timestamp.
Timestamp (datetime) --
A Timestamp that specifies the time the event occurred.
MetricValue (float) --
Value of the anomalous metric data point at respective Timestamp.
StatusCode (string) --
This is an enum of the status showing whether the metric value pair list has partial or complete data, or if there was an error.
PerformanceInsightsMetrics (list) --
An array of PerformanceInsightsMetricsDetail objects that contain information about analyzed Performance Insights metrics that show anomalous behavior.
(dict) --
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.
MetricDisplayName (string) --
The name used for a specific Performance Insights metric.
Unit (string) --
The unit of measure for a metric. For example, a session or a process.
MetricQuery (dict) --
A single query to be processed for the metric. For more information, see PerformanceInsightsMetricQuery .
Metric (string) --
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.
GroupBy (dict) --
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.
Group (string) --
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)
Dimensions (list) --
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)
(string) --
Limit (integer) --
The maximum number of items to fetch for this dimension group.
Filter (dict) --
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.
(string) --
(string) --
ReferenceData (list) --
For more information, see PerformanceInsightsReferenceData .
(dict) --
Reference data used to evaluate Performance Insights to determine if its performance is anomalous or not.
Name (string) --
The name of the reference data.
ComparisonValues (dict) --
The specific reference values used to evaluate the Performance Insights. For more information, see PerformanceInsightsReferenceComparisonValues .
ReferenceScalar (dict) --
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.
Value (float) --
The reference value.
ReferenceMetric (dict) --
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.
MetricQuery (dict) --
A query to be processed on the metric.
Metric (string) --
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.
GroupBy (dict) --
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.
Group (string) --
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)
Dimensions (list) --
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)
(string) --
Limit (integer) --
The maximum number of items to fetch for this dimension group.
Filter (dict) --
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.
(string) --
(string) --
StatsAtAnomaly (list) --
The metric statistics during the anomalous period detected by DevOps Guru;
(dict) --
A statistic in a Performance Insights collection.
Type (string) --
The statistic type.
Value (float) --
The value of the statistic.
StatsAtBaseline (list) --
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.
(dict) --
A statistic in a Performance Insights collection.
Type (string) --
The statistic type.
Value (float) --
The value of the statistic.
AssociatedInsightId (string) --
The ID of the insight that contains this anomaly. An insight is composed of related anomalies.
ResourceCollection (dict) --
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.
CloudFormation (dict) --
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.
StackNames (list) --
An array of CloudFormation stack names.
(string) --
Tags (list) --
The Amazon Web Services tags that are used by resources in the resource collection.
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.
Warning
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 . While keys are case-sensitive, the case of key characters don't matter to DevOps Guru. For example, DevOps Guru works with a key named devops-guru-rds and a key named DevOps-Guru-RDS . Possible key /value pairs in your application might be Devops-Guru-production-application/RDS or Devops-Guru-production-application/containers .
(dict) --
A collection of Amazon Web Services stags.
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.
Warning
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 . While keys are case-sensitive, the case of key characters don't matter to DevOps Guru. For example, DevOps Guru works with a key named devops-guru-rds and a key named DevOps-Guru-RDS . Possible key /value pairs in your application might be Devops-Guru-production-application/RDS or Devops-Guru-production-application/containers .
AppBoundaryKey (string) --
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.
Warning
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 . While keys are case-sensitive, the case of key characters don't matter to DevOps Guru. For example, DevOps Guru works with a key named devops-guru-rds and a key named DevOps-Guru-RDS . Possible key /value pairs in your application might be Devops-Guru-production-application/RDS or Devops-Guru-production-application/containers .
TagValues (list) --
The values in an Amazon Web Services tag collection.
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.
(string) --
Type (string) --
The type of the reactive anomaly. It can be one of the following types.
CAUSAL - the anomaly can cause a new insight.
CONTEXTUAL - the anomaly contains additional information about an insight or its causal anomaly.
Name (string) --
The name of the reactive anomaly.
Description (string) --
A description of the reactive anomaly.
CausalAnomalyId (string) --
The ID of the causal anomaly that is associated with this reactive anomaly. The ID of a CAUSAL anomaly is always NULL.
AnomalyResources (list) --
The Amazon Web Services resources in which anomalous behavior was detected by DevOps Guru.
(dict) --
The Amazon Web Services resources in which DevOps Guru detected unusual behavior that resulted in the generation of an anomaly. When DevOps Guru detects multiple related anomalies, it creates and insight with details about the anomalous behavior and suggestions about how to correct the problem.
Name (string) --
The name of the Amazon Web Services resource.
Type (string) --
The type of the Amazon Web Services resource.
{'ProactiveInsight': {'ResourceCollection': {'Tags': [{'AppBoundaryKey': 'string',
'TagValues': ['string']}]}},
'ReactiveInsight': {'ResourceCollection': {'Tags': [{'AppBoundaryKey': 'string',
'TagValues': ['string']}]}}}
Returns details about an insight that you specify using its ID.
See also: AWS API Documentation
Request Syntax
client.describe_insight(
Id='string',
AccountId='string'
)
string
[REQUIRED]
The ID of the insight.
string
The ID of the member account in the organization.
dict
Response Syntax
{
'ProactiveInsight': {
'Id': 'string',
'Name': 'string',
'Severity': 'LOW'|'MEDIUM'|'HIGH',
'Status': 'ONGOING'|'CLOSED',
'InsightTimeRange': {
'StartTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1)
},
'PredictionTimeRange': {
'StartTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1)
},
'ResourceCollection': {
'CloudFormation': {
'StackNames': [
'string',
]
},
'Tags': [
{
'AppBoundaryKey': 'string',
'TagValues': [
'string',
]
},
]
},
'SsmOpsItemId': 'string'
},
'ReactiveInsight': {
'Id': 'string',
'Name': 'string',
'Severity': 'LOW'|'MEDIUM'|'HIGH',
'Status': 'ONGOING'|'CLOSED',
'InsightTimeRange': {
'StartTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1)
},
'ResourceCollection': {
'CloudFormation': {
'StackNames': [
'string',
]
},
'Tags': [
{
'AppBoundaryKey': 'string',
'TagValues': [
'string',
]
},
]
},
'SsmOpsItemId': 'string'
}
}
Response Structure
(dict) --
ProactiveInsight (dict) --
A ProactiveInsight object that represents the requested insight.
Id (string) --
The ID of the proactive insight.
Name (string) --
The name of the proactive insight.
Severity (string) --
The severity of the insight. For more information, see Understanding insight severities in the Amazon DevOps Guru User Guide .
Status (string) --
The status of the proactive insight.
InsightTimeRange (dict) --
A time ranged that specifies when the observed behavior in an insight started and ended.
StartTime (datetime) --
The time when the behavior described in an insight started.
EndTime (datetime) --
The time when the behavior described in an insight ended.
PredictionTimeRange (dict) --
The time range during which anomalous behavior in a proactive anomaly or an insight is expected to occur.
StartTime (datetime) --
The time range during which a metric limit is expected to be exceeded. This applies to proactive insights only.
EndTime (datetime) --
The time when the behavior in a proactive insight is expected to end.
ResourceCollection (dict) --
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.
CloudFormation (dict) --
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.
StackNames (list) --
An array of CloudFormation stack names.
(string) --
Tags (list) --
The Amazon Web Services tags that are used by resources in the resource collection.
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.
Warning
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 . While keys are case-sensitive, the case of key characters don't matter to DevOps Guru. For example, DevOps Guru works with a key named devops-guru-rds and a key named DevOps-Guru-RDS . Possible key /value pairs in your application might be Devops-Guru-production-application/RDS or Devops-Guru-production-application/containers .
(dict) --
A collection of Amazon Web Services stags.
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.
Warning
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 . While keys are case-sensitive, the case of key characters don't matter to DevOps Guru. For example, DevOps Guru works with a key named devops-guru-rds and a key named DevOps-Guru-RDS . Possible key /value pairs in your application might be Devops-Guru-production-application/RDS or Devops-Guru-production-application/containers .
AppBoundaryKey (string) --
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.
Warning
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 . While keys are case-sensitive, the case of key characters don't matter to DevOps Guru. For example, DevOps Guru works with a key named devops-guru-rds and a key named DevOps-Guru-RDS . Possible key /value pairs in your application might be Devops-Guru-production-application/RDS or Devops-Guru-production-application/containers .
TagValues (list) --
The values in an Amazon Web Services tag collection.
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.
(string) --
SsmOpsItemId (string) --
The ID of the Amazon Web Services System Manager OpsItem created for this insight. You must enable the creation of OpstItems insights before they are created for each insight.
ReactiveInsight (dict) --
A ReactiveInsight object that represents the requested insight.
Id (string) --
The ID of a reactive insight.
Name (string) --
The name of a reactive insight.
Severity (string) --
The severity of the insight. For more information, see Understanding insight severities in the Amazon DevOps Guru User Guide .
Status (string) --
The status of a reactive insight.
InsightTimeRange (dict) --
A time ranged that specifies when the observed behavior in an insight started and ended.
StartTime (datetime) --
The time when the behavior described in an insight started.
EndTime (datetime) --
The time when the behavior described in an insight ended.
ResourceCollection (dict) --
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.
CloudFormation (dict) --
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.
StackNames (list) --
An array of CloudFormation stack names.
(string) --
Tags (list) --
The Amazon Web Services tags that are used by resources in the resource collection.
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.
Warning
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 . While keys are case-sensitive, the case of key characters don't matter to DevOps Guru. For example, DevOps Guru works with a key named devops-guru-rds and a key named DevOps-Guru-RDS . Possible key /value pairs in your application might be Devops-Guru-production-application/RDS or Devops-Guru-production-application/containers .
(dict) --
A collection of Amazon Web Services stags.
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.
Warning
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 . While keys are case-sensitive, the case of key characters don't matter to DevOps Guru. For example, DevOps Guru works with a key named devops-guru-rds and a key named DevOps-Guru-RDS . Possible key /value pairs in your application might be Devops-Guru-production-application/RDS or Devops-Guru-production-application/containers .
AppBoundaryKey (string) --
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.
Warning
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 . While keys are case-sensitive, the case of key characters don't matter to DevOps Guru. For example, DevOps Guru works with a key named devops-guru-rds and a key named DevOps-Guru-RDS . Possible key /value pairs in your application might be Devops-Guru-production-application/RDS or Devops-Guru-production-application/containers .
TagValues (list) --
The values in an Amazon Web Services tag collection.
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.
(string) --
SsmOpsItemId (string) --
The ID of the Amazon Web Services System Manager OpsItem created for this insight. You must enable the creation of OpstItems insights before they are created for each insight.
{'ResourceCollectionType': {'AWS_TAGS'}}
Response {'Tags': [{'AppBoundaryKey': 'string',
'Insight': {'MeanTimeToRecoverInMilliseconds': 'long',
'OpenProactiveInsights': 'integer',
'OpenReactiveInsights': 'integer'},
'TagValue': 'string'}]}
Returns the number of open proactive insights, open reactive insights, and the Mean Time to Recover (MTTR) for all closed insights in resource collections in your account. You specify the type of Amazon Web Services resources collection. 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.
See also: AWS API Documentation
Request Syntax
client.describe_resource_collection_health(
ResourceCollectionType='AWS_CLOUD_FORMATION'|'AWS_SERVICE'|'AWS_TAGS',
NextToken='string'
)
string
[REQUIRED]
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.
string
The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.
dict
Response Syntax
{
'CloudFormation': [
{
'StackName': 'string',
'Insight': {
'OpenProactiveInsights': 123,
'OpenReactiveInsights': 123,
'MeanTimeToRecoverInMilliseconds': 123
}
},
],
'Service': [
{
'ServiceName': 'API_GATEWAY'|'APPLICATION_ELB'|'AUTO_SCALING_GROUP'|'CLOUD_FRONT'|'DYNAMO_DB'|'EC2'|'ECS'|'EKS'|'ELASTIC_BEANSTALK'|'ELASTI_CACHE'|'ELB'|'ES'|'KINESIS'|'LAMBDA'|'NAT_GATEWAY'|'NETWORK_ELB'|'RDS'|'REDSHIFT'|'ROUTE_53'|'S3'|'SAGE_MAKER'|'SNS'|'SQS'|'STEP_FUNCTIONS'|'SWF',
'Insight': {
'OpenProactiveInsights': 123,
'OpenReactiveInsights': 123
}
},
],
'NextToken': 'string',
'Tags': [
{
'AppBoundaryKey': 'string',
'TagValue': 'string',
'Insight': {
'OpenProactiveInsights': 123,
'OpenReactiveInsights': 123,
'MeanTimeToRecoverInMilliseconds': 123
}
},
]
}
Response Structure
(dict) --
CloudFormation (list) --
The returned CloudFormationHealthOverview object that contains an InsightHealthOverview object with the requested system health information.
(dict) --
Information about the health of Amazon Web Services resources in your account that are specified by an Amazon Web Services CloudFormation stack.
StackName (string) --
The name of the CloudFormation stack.
Insight (dict) --
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.
OpenProactiveInsights (integer) --
The number of open proactive insights.
OpenReactiveInsights (integer) --
The number of open reactive insights.
MeanTimeToRecoverInMilliseconds (integer) --
The Meant Time to Recover (MTTR) for the insight.
Service (list) --
An array of ServiceHealth objects that describes the health of the Amazon Web Services services associated with the resources in the collection.
(dict) --
Represents the health of an Amazon Web Services service.
ServiceName (string) --
The name of the Amazon Web Services service.
Insight (dict) --
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.
OpenProactiveInsights (integer) --
The number of open proactive insights in the Amazon Web Services service
OpenReactiveInsights (integer) --
The number of open reactive insights in the Amazon Web Services service
NextToken (string) --
The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.
Tags (list) --
The Amazon Web Services tags that are used by resources in the resource collection.
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.
Warning
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 . While keys are case-sensitive, the case of key characters don't matter to DevOps Guru. For example, DevOps Guru works with a key named devops-guru-rds and a key named DevOps-Guru-RDS . Possible key /value pairs in your application might be Devops-Guru-production-application/RDS or Devops-Guru-production-application/containers .
(dict) --
Information about the health of Amazon Web Services resources in your account that are specified by an Amazon Web Services tag key .
AppBoundaryKey (string) --
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.
Warning
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 . While keys are case-sensitive, the case of key characters don't matter to DevOps Guru. For example, DevOps Guru works with a key named devops-guru-rds and a key named DevOps-Guru-RDS . Possible key /value pairs in your application might be Devops-Guru-production-application/RDS or Devops-Guru-production-application/containers .
TagValue (string) --
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.
Insight (dict) --
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.
OpenProactiveInsights (integer) --
The number of open proactive insights.
OpenReactiveInsights (integer) --
The number of open reactive insights.
MeanTimeToRecoverInMilliseconds (integer) --
The Meant Time to Recover (MTTR) for the insight.
{'ResourceCollection': {'Tags': [{'AppBoundaryKey': 'string',
'TagValues': ['string']}]}}
Returns an estimate of the monthly cost for DevOps Guru to analyze your Amazon Web Services resources. For more information, see Estimate your Amazon DevOps Guru costs and Amazon DevOps Guru pricing.
See also: AWS API Documentation
Request Syntax
client.get_cost_estimation(
NextToken='string'
)
string
The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.
dict
Response Syntax
{
'ResourceCollection': {
'CloudFormation': {
'StackNames': [
'string',
]
},
'Tags': [
{
'AppBoundaryKey': 'string',
'TagValues': [
'string',
]
},
]
},
'Status': 'ONGOING'|'COMPLETED',
'Costs': [
{
'Type': 'string',
'State': 'ACTIVE'|'INACTIVE',
'Count': 123,
'UnitCost': 123.0,
'Cost': 123.0
},
],
'TimeRange': {
'StartTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1)
},
'TotalCost': 123.0,
'NextToken': 'string'
}
Response Structure
(dict) --
ResourceCollection (dict) --
The collection of the Amazon Web Services resources used to create your monthly DevOps Guru cost estimate.
CloudFormation (dict) --
An object that specifies the CloudFormation stack that defines the Amazon Web Services resources used to create a monthly estimate for DevOps Guru.
StackNames (list) --
An array of CloudFormation stack names. Its size is fixed at 1 item.
(string) --
Tags (list) --
The Amazon Web Services tags used to filter the resource collection that is used for a cost estimate.
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.
Warning
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 . While keys are case-sensitive, the case of key characters don't matter to DevOps Guru. For example, DevOps Guru works with a key named devops-guru-rds and a key named DevOps-Guru-RDS . Possible key /value pairs in your application might be Devops-Guru-production-application/RDS or Devops-Guru-production-application/containers .
(dict) --
Information about a collection of Amazon Web Services resources that are identified by an Amazon Web Services tag. This collection of resources is used to create a monthly cost estimate for DevOps Guru to analyze Amazon Web Services resources. The maximum number of tags you can specify for a cost estimate is one. The estimate created is for the cost to analyze the Amazon Web Services resources defined by the tag. For more information, see Stacks in the Amazon Web Services CloudFormation User Guide .
AppBoundaryKey (string) --
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.
Warning
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 . While keys are case-sensitive, the case of key characters don't matter to DevOps Guru. For example, DevOps Guru works with a key named devops-guru-rds and a key named DevOps-Guru-RDS . Possible key /value pairs in your application might be Devops-Guru-production-application/RDS or Devops-Guru-production-application/containers .
TagValues (list) --
The values in an Amazon Web Services tag collection.
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.
(string) --
Status (string) --
The status of creating this cost estimate. If it's still in progress, the status ONGOING is returned. If it is finished, the status COMPLETED is returned.
Costs (list) --
An array of ResourceCost objects that each contains details about the monthly cost estimate to analyze one of your Amazon Web Services resources.
(dict) --
An object that contains information about the estimated monthly cost to analyze an Amazon Web Services resource. For more information, see Estimate your Amazon DevOps Guru costs and Amazon DevOps Guru pricing.
Type (string) --
The type of the Amazon Web Services resource.
State (string) --
The state of the resource. The resource is ACTIVE if it produces metrics, events, or logs within an hour, otherwise it is INACTIVE . You pay for the number of active Amazon Web Services resource hours analyzed for each resource. Inactive resources are not charged.
Count (integer) --
The number of active resources analyzed for this service to create a monthly cost estimate.
UnitCost (float) --
The price per hour to analyze the resources in the service. For more information, see Estimate your Amazon DevOps Guru costs and Amazon DevOps Guru pricing.
Cost (float) --
The total estimated monthly cost to analyze the active resources for this resource.
TimeRange (dict) --
The start and end time of the cost estimation.
StartTime (datetime) --
The start time of the cost estimation.
EndTime (datetime) --
The end time of the cost estimation.
TotalCost (float) --
The estimated monthly cost to analyze the Amazon Web Services resources. This value is the sum of the estimated costs to analyze each resource in the Costs object in this response.
NextToken (string) --
The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.
{'ResourceCollectionType': {'AWS_TAGS'}}
Response {'ResourceCollection': {'Tags': [{'AppBoundaryKey': 'string',
'TagValues': ['string']}]}}
Returns lists Amazon Web Services resources that are of the specified resource collection type. 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.
See also: AWS API Documentation
Request Syntax
client.get_resource_collection(
ResourceCollectionType='AWS_CLOUD_FORMATION'|'AWS_SERVICE'|'AWS_TAGS',
NextToken='string'
)
string
[REQUIRED]
The type of Amazon Web Services resource collections to return. The one valid value is CLOUD_FORMATION for Amazon Web Services CloudFormation stacks.
string
The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.
dict
Response Syntax
{
'ResourceCollection': {
'CloudFormation': {
'StackNames': [
'string',
]
},
'Tags': [
{
'AppBoundaryKey': 'string',
'TagValues': [
'string',
]
},
]
},
'NextToken': 'string'
}
Response Structure
(dict) --
ResourceCollection (dict) --
The requested list of Amazon Web Services resource collections. 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.
CloudFormation (dict) --
Information about Amazon Web Services CloudFormation stacks. You can use up to 500 stacks to specify which Amazon Web Services resources in your account to analyze. For more information, see Stacks in the Amazon Web Services CloudFormation User Guide .
StackNames (list) --
An array of CloudFormation stack names.
(string) --
Tags (list) --
The Amazon Web Services tags used to filter the resources in the resource collection.
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.
Warning
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 . While keys are case-sensitive, the case of key characters don't matter to DevOps Guru. For example, DevOps Guru works with a key named devops-guru-rds and a key named DevOps-Guru-RDS . Possible key /value pairs in your application might be Devops-Guru-production-application/RDS or Devops-Guru-production-application/containers .
(dict) --
A collection of Amazon Web Services tags used to filter insights. This is used to return insights generated from only resources that contain the tags in the tag collection.
AppBoundaryKey (string) --
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.
Warning
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 . While keys are case-sensitive, the case of key characters don't matter to DevOps Guru. For example, DevOps Guru works with a key named devops-guru-rds and a key named DevOps-Guru-RDS . Possible key /value pairs in your application might be Devops-Guru-production-application/RDS or Devops-Guru-production-application/containers .
TagValues (list) --
The values in an Amazon Web Services tag collection.
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.
(string) --
NextToken (string) --
The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.
{'ProactiveAnomalies': {'ResourceCollection': {'Tags': [{'AppBoundaryKey': 'string',
'TagValues': ['string']}]},
'SourceDetails': {'PerformanceInsightsMetrics': [{'MetricDisplayName': 'string',
'MetricQuery': {'Filter': {'string': 'string'},
'GroupBy': {'Dimensions': ['string'],
'Group': 'string',
'Limit': 'integer'},
'Metric': 'string'},
'ReferenceData': [{'ComparisonValues': {'ReferenceMetric': {'MetricQuery': {'Filter': {'string': 'string'},
'GroupBy': {'Dimensions': ['string'],
'Group': 'string',
'Limit': 'integer'},
'Metric': 'string'}},
'ReferenceScalar': {'Value': 'double'}},
'Name': 'string'}],
'StatsAtAnomaly': [{'Type': 'string',
'Value': 'double'}],
'StatsAtBaseline': [{'Type': 'string',
'Value': 'double'}],
'Unit': 'string'}]}},
'ReactiveAnomalies': {'AnomalyResources': [{'Name': 'string',
'Type': 'string'}],
'CausalAnomalyId': 'string',
'Description': 'string',
'Name': 'string',
'ResourceCollection': {'Tags': [{'AppBoundaryKey': 'string',
'TagValues': ['string']}]},
'SourceDetails': {'PerformanceInsightsMetrics': [{'MetricDisplayName': 'string',
'MetricQuery': {'Filter': {'string': 'string'},
'GroupBy': {'Dimensions': ['string'],
'Group': 'string',
'Limit': 'integer'},
'Metric': 'string'},
'ReferenceData': [{'ComparisonValues': {'ReferenceMetric': {'MetricQuery': {'Filter': {'string': 'string'},
'GroupBy': {'Dimensions': ['string'],
'Group': 'string',
'Limit': 'integer'},
'Metric': 'string'}},
'ReferenceScalar': {'Value': 'double'}},
'Name': 'string'}],
'StatsAtAnomaly': [{'Type': 'string',
'Value': 'double'}],
'StatsAtBaseline': [{'Type': 'string',
'Value': 'double'}],
'Unit': 'string'}]},
'Type': 'CAUSAL | CONTEXTUAL'}}
Returns a list of the anomalies that belong to an insight that you specify using its ID.
See also: AWS API Documentation
Request Syntax
client.list_anomalies_for_insight(
InsightId='string',
StartTimeRange={
'FromTime': datetime(2015, 1, 1),
'ToTime': datetime(2015, 1, 1)
},
MaxResults=123,
NextToken='string',
AccountId='string'
)
string
[REQUIRED]
The ID of the insight. The returned anomalies belong to this insight.
dict
A time range used to specify when the requested anomalies started. All returned anomalies started during this time range.
FromTime (datetime) --
The start time of the time range.
ToTime (datetime) --
The end time of the time range.
integer
The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
string
The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.
string
The ID of the Amazon Web Services account.
dict
Response Syntax
{
'ProactiveAnomalies': [
{
'Id': 'string',
'Severity': 'LOW'|'MEDIUM'|'HIGH',
'Status': 'ONGOING'|'CLOSED',
'UpdateTime': datetime(2015, 1, 1),
'AnomalyTimeRange': {
'StartTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1)
},
'AnomalyReportedTimeRange': {
'OpenTime': datetime(2015, 1, 1),
'CloseTime': datetime(2015, 1, 1)
},
'PredictionTimeRange': {
'StartTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1)
},
'SourceDetails': {
'CloudWatchMetrics': [
{
'MetricName': 'string',
'Namespace': 'string',
'Dimensions': [
{
'Name': 'string',
'Value': 'string'
},
],
'Stat': 'Sum'|'Average'|'SampleCount'|'Minimum'|'Maximum'|'p99'|'p90'|'p50',
'Unit': 'string',
'Period': 123,
'MetricDataSummary': {
'TimestampMetricValuePairList': [
{
'Timestamp': datetime(2015, 1, 1),
'MetricValue': 123.0
},
],
'StatusCode': 'Complete'|'InternalError'|'PartialData'
}
},
],
'PerformanceInsightsMetrics': [
{
'MetricDisplayName': 'string',
'Unit': 'string',
'MetricQuery': {
'Metric': 'string',
'GroupBy': {
'Group': 'string',
'Dimensions': [
'string',
],
'Limit': 123
},
'Filter': {
'string': 'string'
}
},
'ReferenceData': [
{
'Name': 'string',
'ComparisonValues': {
'ReferenceScalar': {
'Value': 123.0
},
'ReferenceMetric': {
'MetricQuery': {
'Metric': 'string',
'GroupBy': {
'Group': 'string',
'Dimensions': [
'string',
],
'Limit': 123
},
'Filter': {
'string': 'string'
}
}
}
}
},
],
'StatsAtAnomaly': [
{
'Type': 'string',
'Value': 123.0
},
],
'StatsAtBaseline': [
{
'Type': 'string',
'Value': 123.0
},
]
},
]
},
'AssociatedInsightId': 'string',
'ResourceCollection': {
'CloudFormation': {
'StackNames': [
'string',
]
},
'Tags': [
{
'AppBoundaryKey': 'string',
'TagValues': [
'string',
]
},
]
},
'Limit': 123.0
},
],
'ReactiveAnomalies': [
{
'Id': 'string',
'Severity': 'LOW'|'MEDIUM'|'HIGH',
'Status': 'ONGOING'|'CLOSED',
'AnomalyTimeRange': {
'StartTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1)
},
'AnomalyReportedTimeRange': {
'OpenTime': datetime(2015, 1, 1),
'CloseTime': datetime(2015, 1, 1)
},
'SourceDetails': {
'CloudWatchMetrics': [
{
'MetricName': 'string',
'Namespace': 'string',
'Dimensions': [
{
'Name': 'string',
'Value': 'string'
},
],
'Stat': 'Sum'|'Average'|'SampleCount'|'Minimum'|'Maximum'|'p99'|'p90'|'p50',
'Unit': 'string',
'Period': 123,
'MetricDataSummary': {
'TimestampMetricValuePairList': [
{
'Timestamp': datetime(2015, 1, 1),
'MetricValue': 123.0
},
],
'StatusCode': 'Complete'|'InternalError'|'PartialData'
}
},
],
'PerformanceInsightsMetrics': [
{
'MetricDisplayName': 'string',
'Unit': 'string',
'MetricQuery': {
'Metric': 'string',
'GroupBy': {
'Group': 'string',
'Dimensions': [
'string',
],
'Limit': 123
},
'Filter': {
'string': 'string'
}
},
'ReferenceData': [
{
'Name': 'string',
'ComparisonValues': {
'ReferenceScalar': {
'Value': 123.0
},
'ReferenceMetric': {
'MetricQuery': {
'Metric': 'string',
'GroupBy': {
'Group': 'string',
'Dimensions': [
'string',
],
'Limit': 123
},
'Filter': {
'string': 'string'
}
}
}
}
},
],
'StatsAtAnomaly': [
{
'Type': 'string',
'Value': 123.0
},
],
'StatsAtBaseline': [
{
'Type': 'string',
'Value': 123.0
},
]
},
]
},
'AssociatedInsightId': 'string',
'ResourceCollection': {
'CloudFormation': {
'StackNames': [
'string',
]
},
'Tags': [
{
'AppBoundaryKey': 'string',
'TagValues': [
'string',
]
},
]
},
'Type': 'CAUSAL'|'CONTEXTUAL',
'Name': 'string',
'Description': 'string',
'CausalAnomalyId': 'string',
'AnomalyResources': [
{
'Name': 'string',
'Type': 'string'
},
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
ProactiveAnomalies (list) --
An array of ProactiveAnomalySummary objects that represent the requested anomalies
(dict) --
Details about a proactive anomaly. This object is returned by DescribeAnomaly.
Id (string) --
The ID of the anomaly.
Severity (string) --
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 .
Status (string) --
The status of the anomaly.
UpdateTime (datetime) --
The time of the anomaly's most recent update.
AnomalyTimeRange (dict) --
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.
StartTime (datetime) --
The time when the anomalous behavior started.
EndTime (datetime) --
The time when the anomalous behavior ended.
AnomalyReportedTimeRange (dict) --
An AnomalyReportedTimeRange object that specifies the time range between when the anomaly is opened and the time when it is closed.
OpenTime (datetime) --
The time when an anomaly is opened.
CloseTime (datetime) --
The time when an anomaly is closed.
PredictionTimeRange (dict) --
The time range during which anomalous behavior in a proactive anomaly or an insight is expected to occur.
StartTime (datetime) --
The time range during which a metric limit is expected to be exceeded. This applies to proactive insights only.
EndTime (datetime) --
The time when the behavior in a proactive insight is expected to end.
SourceDetails (dict) --
Details about the source of the analyzed operational data that triggered the anomaly. The one supported source is Amazon CloudWatch metrics.
CloudWatchMetrics (list) --
An array of CloudWatchMetricsDetail objects that contain information about analyzed CloudWatch metrics that show anomalous behavior.
(dict) --
Information about an Amazon CloudWatch metric.
MetricName (string) --
The name of the CloudWatch metric.
Namespace (string) --
The namespace of the CloudWatch metric. A namespace is a container for CloudWatch metrics.
Dimensions (list) --
An array of CloudWatch dimensions associated with
(dict) --
The dimension of am Amazon CloudWatch metric that is used when DevOps Guru analyzes the resources in your account for operational problems and anomalous behavior. A dimension is a name/value pair that is part of the identity of a metric. A metric can have up to 10 dimensions. For more information, see Dimensions in the Amazon CloudWatch User Guide .
Name (string) --
The name of the CloudWatch dimension.
Value (string) --
The value of the CloudWatch dimension.
Stat (string) --
The type of statistic associated with the CloudWatch metric. For more information, see Statistics in the Amazon CloudWatch User Guide .
Unit (string) --
The unit of measure used for the CloudWatch metric. For example, Bytes , Seconds , Count , and Percent .
Period (integer) --
The length of time associated with the CloudWatch metric in number of seconds.
MetricDataSummary (dict) --
This object returns anomaly metric data.
TimestampMetricValuePairList (list) --
This is a list of Amazon CloudWatch metric values at given timestamp.
(dict) --
A pair that contains metric values at the respective timestamp.
Timestamp (datetime) --
A Timestamp that specifies the time the event occurred.
MetricValue (float) --
Value of the anomalous metric data point at respective Timestamp.
StatusCode (string) --
This is an enum of the status showing whether the metric value pair list has partial or complete data, or if there was an error.
PerformanceInsightsMetrics (list) --
An array of PerformanceInsightsMetricsDetail objects that contain information about analyzed Performance Insights metrics that show anomalous behavior.
(dict) --
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.
MetricDisplayName (string) --
The name used for a specific Performance Insights metric.
Unit (string) --
The unit of measure for a metric. For example, a session or a process.
MetricQuery (dict) --
A single query to be processed for the metric. For more information, see PerformanceInsightsMetricQuery .
Metric (string) --
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.
GroupBy (dict) --
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.
Group (string) --
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)
Dimensions (list) --
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)
(string) --
Limit (integer) --
The maximum number of items to fetch for this dimension group.
Filter (dict) --
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.
(string) --
(string) --
ReferenceData (list) --
For more information, see PerformanceInsightsReferenceData .
(dict) --
Reference data used to evaluate Performance Insights to determine if its performance is anomalous or not.
Name (string) --
The name of the reference data.
ComparisonValues (dict) --
The specific reference values used to evaluate the Performance Insights. For more information, see PerformanceInsightsReferenceComparisonValues .
ReferenceScalar (dict) --
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.
Value (float) --
The reference value.
ReferenceMetric (dict) --
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.
MetricQuery (dict) --
A query to be processed on the metric.
Metric (string) --
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.
GroupBy (dict) --
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.
Group (string) --
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)
Dimensions (list) --
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)
(string) --
Limit (integer) --
The maximum number of items to fetch for this dimension group.
Filter (dict) --
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.
(string) --
(string) --
StatsAtAnomaly (list) --
The metric statistics during the anomalous period detected by DevOps Guru;
(dict) --
A statistic in a Performance Insights collection.
Type (string) --
The statistic type.
Value (float) --
The value of the statistic.
StatsAtBaseline (list) --
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.
(dict) --
A statistic in a Performance Insights collection.
Type (string) --
The statistic type.
Value (float) --
The value of the statistic.
AssociatedInsightId (string) --
The ID of the insight that contains this anomaly. An insight is composed of related anomalies.
ResourceCollection (dict) --
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.
CloudFormation (dict) --
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.
StackNames (list) --
An array of CloudFormation stack names.
(string) --
Tags (list) --
The Amazon Web Services tags that are used by resources in the resource collection.
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.
Warning
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 . While keys are case-sensitive, the case of key characters don't matter to DevOps Guru. For example, DevOps Guru works with a key named devops-guru-rds and a key named DevOps-Guru-RDS . Possible key /value pairs in your application might be Devops-Guru-production-application/RDS or Devops-Guru-production-application/containers .
(dict) --
A collection of Amazon Web Services stags.
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.
Warning
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 . While keys are case-sensitive, the case of key characters don't matter to DevOps Guru. For example, DevOps Guru works with a key named devops-guru-rds and a key named DevOps-Guru-RDS . Possible key /value pairs in your application might be Devops-Guru-production-application/RDS or Devops-Guru-production-application/containers .
AppBoundaryKey (string) --
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.
Warning
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 . While keys are case-sensitive, the case of key characters don't matter to DevOps Guru. For example, DevOps Guru works with a key named devops-guru-rds and a key named DevOps-Guru-RDS . Possible key /value pairs in your application might be Devops-Guru-production-application/RDS or Devops-Guru-production-application/containers .
TagValues (list) --
The values in an Amazon Web Services tag collection.
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.
(string) --
Limit (float) --
A threshold that was exceeded by behavior in analyzed resources. Exceeding this threshold is related to the anomalous behavior that generated this anomaly.
ReactiveAnomalies (list) --
An array of ReactiveAnomalySummary objects that represent the requested anomalies
(dict) --
Details about a reactive anomaly. This object is returned by DescribeAnomaly.
Id (string) --
The ID of the reactive anomaly.
Severity (string) --
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 .
Status (string) --
The status of the reactive anomaly.
AnomalyTimeRange (dict) --
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.
StartTime (datetime) --
The time when the anomalous behavior started.
EndTime (datetime) --
The time when the anomalous behavior ended.
AnomalyReportedTimeRange (dict) --
An AnomalyReportedTimeRange object that specifies the time range between when the anomaly is opened and the time when it is closed.
OpenTime (datetime) --
The time when an anomaly is opened.
CloseTime (datetime) --
The time when an anomaly is closed.
SourceDetails (dict) --
Details about the source of the analyzed operational data that triggered the anomaly. The one supported source is Amazon CloudWatch metrics.
CloudWatchMetrics (list) --
An array of CloudWatchMetricsDetail objects that contain information about analyzed CloudWatch metrics that show anomalous behavior.
(dict) --
Information about an Amazon CloudWatch metric.
MetricName (string) --
The name of the CloudWatch metric.
Namespace (string) --
The namespace of the CloudWatch metric. A namespace is a container for CloudWatch metrics.
Dimensions (list) --
An array of CloudWatch dimensions associated with
(dict) --
The dimension of am Amazon CloudWatch metric that is used when DevOps Guru analyzes the resources in your account for operational problems and anomalous behavior. A dimension is a name/value pair that is part of the identity of a metric. A metric can have up to 10 dimensions. For more information, see Dimensions in the Amazon CloudWatch User Guide .
Name (string) --
The name of the CloudWatch dimension.
Value (string) --
The value of the CloudWatch dimension.
Stat (string) --
The type of statistic associated with the CloudWatch metric. For more information, see Statistics in the Amazon CloudWatch User Guide .
Unit (string) --
The unit of measure used for the CloudWatch metric. For example, Bytes , Seconds , Count , and Percent .
Period (integer) --
The length of time associated with the CloudWatch metric in number of seconds.
MetricDataSummary (dict) --
This object returns anomaly metric data.
TimestampMetricValuePairList (list) --
This is a list of Amazon CloudWatch metric values at given timestamp.
(dict) --
A pair that contains metric values at the respective timestamp.
Timestamp (datetime) --
A Timestamp that specifies the time the event occurred.
MetricValue (float) --
Value of the anomalous metric data point at respective Timestamp.
StatusCode (string) --
This is an enum of the status showing whether the metric value pair list has partial or complete data, or if there was an error.
PerformanceInsightsMetrics (list) --
An array of PerformanceInsightsMetricsDetail objects that contain information about analyzed Performance Insights metrics that show anomalous behavior.
(dict) --
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.
MetricDisplayName (string) --
The name used for a specific Performance Insights metric.
Unit (string) --
The unit of measure for a metric. For example, a session or a process.
MetricQuery (dict) --
A single query to be processed for the metric. For more information, see PerformanceInsightsMetricQuery .
Metric (string) --
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.
GroupBy (dict) --
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.
Group (string) --
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)
Dimensions (list) --
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)
(string) --
Limit (integer) --
The maximum number of items to fetch for this dimension group.
Filter (dict) --
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.
(string) --
(string) --
ReferenceData (list) --
For more information, see PerformanceInsightsReferenceData .
(dict) --
Reference data used to evaluate Performance Insights to determine if its performance is anomalous or not.
Name (string) --
The name of the reference data.
ComparisonValues (dict) --
The specific reference values used to evaluate the Performance Insights. For more information, see PerformanceInsightsReferenceComparisonValues .
ReferenceScalar (dict) --
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.
Value (float) --
The reference value.
ReferenceMetric (dict) --
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.
MetricQuery (dict) --
A query to be processed on the metric.
Metric (string) --
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.
GroupBy (dict) --
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.
Group (string) --
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)
Dimensions (list) --
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)
(string) --
Limit (integer) --
The maximum number of items to fetch for this dimension group.
Filter (dict) --
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.
(string) --
(string) --
StatsAtAnomaly (list) --
The metric statistics during the anomalous period detected by DevOps Guru;
(dict) --
A statistic in a Performance Insights collection.
Type (string) --
The statistic type.
Value (float) --
The value of the statistic.
StatsAtBaseline (list) --
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.
(dict) --
A statistic in a Performance Insights collection.
Type (string) --
The statistic type.
Value (float) --
The value of the statistic.
AssociatedInsightId (string) --
The ID of the insight that contains this anomaly. An insight is composed of related anomalies.
ResourceCollection (dict) --
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.
CloudFormation (dict) --
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.
StackNames (list) --
An array of CloudFormation stack names.
(string) --
Tags (list) --
The Amazon Web Services tags that are used by resources in the resource collection.
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.
Warning
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 . While keys are case-sensitive, the case of key characters don't matter to DevOps Guru. For example, DevOps Guru works with a key named devops-guru-rds and a key named DevOps-Guru-RDS . Possible key /value pairs in your application might be Devops-Guru-production-application/RDS or Devops-Guru-production-application/containers .
(dict) --
A collection of Amazon Web Services stags.
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.
Warning
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 . While keys are case-sensitive, the case of key characters don't matter to DevOps Guru. For example, DevOps Guru works with a key named devops-guru-rds and a key named DevOps-Guru-RDS . Possible key /value pairs in your application might be Devops-Guru-production-application/RDS or Devops-Guru-production-application/containers .
AppBoundaryKey (string) --
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.
Warning
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 . While keys are case-sensitive, the case of key characters don't matter to DevOps Guru. For example, DevOps Guru works with a key named devops-guru-rds and a key named DevOps-Guru-RDS . Possible key /value pairs in your application might be Devops-Guru-production-application/RDS or Devops-Guru-production-application/containers .
TagValues (list) --
The values in an Amazon Web Services tag collection.
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.
(string) --
Type (string) --
The type of the reactive anomaly. It can be one of the following types.
CAUSAL - the anomaly can cause a new insight.
CONTEXTUAL - the anomaly contains additional information about an insight or its causal anomaly.
Name (string) --
The name of the reactive anomaly.
Description (string) --
A description of the reactive anomaly.
CausalAnomalyId (string) --
The ID of the causal anomaly that is associated with this reactive anomaly. The ID of a CAUSAL anomaly is always NULL.
AnomalyResources (list) --
The Amazon Web Services resources in which anomalous behavior was detected by DevOps Guru.
(dict) --
The Amazon Web Services resources in which DevOps Guru detected unusual behavior that resulted in the generation of an anomaly. When DevOps Guru detects multiple related anomalies, it creates and insight with details about the anomalous behavior and suggestions about how to correct the problem.
Name (string) --
The name of the Amazon Web Services resource.
Type (string) --
The type of the Amazon Web Services resource.
NextToken (string) --
The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.
{'Filters': {'ResourceCollection': {'Tags': [{'AppBoundaryKey': 'string',
'TagValues': ['string']}]}}}
Response {'Events': {'ResourceCollection': {'Tags': [{'AppBoundaryKey': 'string',
'TagValues': ['string']}]}}}
Returns a list of the events emitted by the resources that are evaluated by DevOps Guru. You can use filters to specify which events are returned.
See also: AWS API Documentation
Request Syntax
client.list_events(
Filters={
'InsightId': 'string',
'EventTimeRange': {
'FromTime': datetime(2015, 1, 1),
'ToTime': datetime(2015, 1, 1)
},
'EventClass': 'INFRASTRUCTURE'|'DEPLOYMENT'|'SECURITY_CHANGE'|'CONFIG_CHANGE'|'SCHEMA_CHANGE',
'EventSource': 'string',
'DataSource': 'AWS_CLOUD_TRAIL'|'AWS_CODE_DEPLOY',
'ResourceCollection': {
'CloudFormation': {
'StackNames': [
'string',
]
},
'Tags': [
{
'AppBoundaryKey': 'string',
'TagValues': [
'string',
]
},
]
}
},
MaxResults=123,
NextToken='string',
AccountId='string'
)
dict
[REQUIRED]
A ListEventsFilters object used to specify which events to return.
InsightId (string) --
An ID of an insight that is related to the events you want to filter for.
EventTimeRange (dict) --
A time range during which you want the filtered events to have occurred.
FromTime (datetime) -- [REQUIRED]
The time when the event started.
ToTime (datetime) -- [REQUIRED]
The time when the event ended.
EventClass (string) --
The class of the events you want to filter for, such as an infrastructure change, a deployment, or a schema change.
EventSource (string) --
The Amazon Web Services source that emitted the events you want to filter for.
DataSource (string) --
The source, AWS_CLOUD_TRAIL or AWS_CODE_DEPLOY , of the events you want returned.
ResourceCollection (dict) --
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.
CloudFormation (dict) --
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.
StackNames (list) --
An array of CloudFormation stack names.
(string) --
Tags (list) --
The Amazon Web Services tags that are used by resources in the resource collection.
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.
Warning
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 . While keys are case-sensitive, the case of key characters don't matter to DevOps Guru. For example, DevOps Guru works with a key named devops-guru-rds and a key named DevOps-Guru-RDS . Possible key /value pairs in your application might be Devops-Guru-production-application/RDS or Devops-Guru-production-application/containers .
(dict) --
A collection of Amazon Web Services stags.
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.
Warning
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 . While keys are case-sensitive, the case of key characters don't matter to DevOps Guru. For example, DevOps Guru works with a key named devops-guru-rds and a key named DevOps-Guru-RDS . Possible key /value pairs in your application might be Devops-Guru-production-application/RDS or Devops-Guru-production-application/containers .
AppBoundaryKey (string) -- [REQUIRED]
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.
Warning
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 . While keys are case-sensitive, the case of key characters don't matter to DevOps Guru. For example, DevOps Guru works with a key named devops-guru-rds and a key named DevOps-Guru-RDS . Possible key /value pairs in your application might be Devops-Guru-production-application/RDS or Devops-Guru-production-application/containers .
TagValues (list) -- [REQUIRED]
The values in an Amazon Web Services tag collection.
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.
(string) --
integer
The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
string
The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.
string
The ID of the Amazon Web Services account.
dict
Response Syntax
{
'Events': [
{
'ResourceCollection': {
'CloudFormation': {
'StackNames': [
'string',
]
},
'Tags': [
{
'AppBoundaryKey': 'string',
'TagValues': [
'string',
]
},
]
},
'Id': 'string',
'Time': datetime(2015, 1, 1),
'EventSource': 'string',
'Name': 'string',
'DataSource': 'AWS_CLOUD_TRAIL'|'AWS_CODE_DEPLOY',
'EventClass': 'INFRASTRUCTURE'|'DEPLOYMENT'|'SECURITY_CHANGE'|'CONFIG_CHANGE'|'SCHEMA_CHANGE',
'Resources': [
{
'Type': 'string',
'Name': 'string',
'Arn': 'string'
},
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Events (list) --
A list of the requested events.
(dict) --
An Amazon Web Services resource event. Amazon Web Services resource events and metrics are analyzed by DevOps Guru to find anomalous behavior and provide recommendations to improve your operational solutions.
ResourceCollection (dict) --
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.
CloudFormation (dict) --
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.
StackNames (list) --
An array of CloudFormation stack names.
(string) --
Tags (list) --
The Amazon Web Services tags that are used by resources in the resource collection.
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.
Warning
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 . While keys are case-sensitive, the case of key characters don't matter to DevOps Guru. For example, DevOps Guru works with a key named devops-guru-rds and a key named DevOps-Guru-RDS . Possible key /value pairs in your application might be Devops-Guru-production-application/RDS or Devops-Guru-production-application/containers .
(dict) --
A collection of Amazon Web Services stags.
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.
Warning
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 . While keys are case-sensitive, the case of key characters don't matter to DevOps Guru. For example, DevOps Guru works with a key named devops-guru-rds and a key named DevOps-Guru-RDS . Possible key /value pairs in your application might be Devops-Guru-production-application/RDS or Devops-Guru-production-application/containers .
AppBoundaryKey (string) --
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.
Warning
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 . While keys are case-sensitive, the case of key characters don't matter to DevOps Guru. For example, DevOps Guru works with a key named devops-guru-rds and a key named DevOps-Guru-RDS . Possible key /value pairs in your application might be Devops-Guru-production-application/RDS or Devops-Guru-production-application/containers .
TagValues (list) --
The values in an Amazon Web Services tag collection.
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.
(string) --
Id (string) --
The ID of the event.
Time (datetime) --
A Timestamp that specifies the time the event occurred.
EventSource (string) --
The Amazon Web Services source that emitted the event.
Name (string) --
The name of the event.
DataSource (string) --
The source, AWS_CLOUD_TRAIL or AWS_CODE_DEPLOY , where DevOps Guru analysis found the event.
EventClass (string) --
The class of the event. The class specifies what the event is related to, such as an infrastructure change, a deployment, or a schema change.
Resources (list) --
An EventResource object that contains information about the resource that emitted the event.
(dict) --
The Amazon Web Services resource that emitted an event. Amazon Web Services resource events and metrics are analyzed by DevOps Guru to find anomalous behavior and provide recommendations to improve your operational solutions.
Type (string) --
The type of resource that emitted an event.
Name (string) --
The name of the resource that emitted an event.
Arn (string) --
The Amazon Resource Name (ARN) of the resource that emitted an event.
NextToken (string) --
The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.
{'ProactiveInsights': {'AssociatedResourceArns': ['string'],
'ResourceCollection': {'Tags': [{'AppBoundaryKey': 'string',
'TagValues': ['string']}]}},
'ReactiveInsights': {'AssociatedResourceArns': ['string'],
'ResourceCollection': {'Tags': [{'AppBoundaryKey': 'string',
'TagValues': ['string']}]}}}
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 ).
See also: AWS API Documentation
Request Syntax
client.list_insights(
StatusFilter={
'Ongoing': {
'Type': 'REACTIVE'|'PROACTIVE'
},
'Closed': {
'Type': 'REACTIVE'|'PROACTIVE',
'EndTimeRange': {
'FromTime': datetime(2015, 1, 1),
'ToTime': datetime(2015, 1, 1)
}
},
'Any': {
'Type': 'REACTIVE'|'PROACTIVE',
'StartTimeRange': {
'FromTime': datetime(2015, 1, 1),
'ToTime': datetime(2015, 1, 1)
}
}
},
MaxResults=123,
NextToken='string'
)
dict
[REQUIRED]
A filter used to filter the returned insights by their status. You can specify one status filter.
Ongoing (dict) --
A ListInsightsAnyStatusFilter that specifies ongoing insights that are either REACTIVE or PROACTIVE .
Type (string) -- [REQUIRED]
Use to filter for either REACTIVE or PROACTIVE insights.
Closed (dict) --
A ListInsightsClosedStatusFilter that specifies closed insights that are either REACTIVE or PROACTIVE .
Type (string) -- [REQUIRED]
Use to filter for either REACTIVE or PROACTIVE insights.
EndTimeRange (dict) -- [REQUIRED]
A time range used to specify when the behavior of the filtered insights ended.
FromTime (datetime) --
The earliest end time in the time range.
ToTime (datetime) --
The latest end time in the time range.
Any (dict) --
A ListInsightsAnyStatusFilter that specifies insights of any status that are either REACTIVE or PROACTIVE .
Type (string) -- [REQUIRED]
Use to filter for either REACTIVE or PROACTIVE insights.
StartTimeRange (dict) -- [REQUIRED]
A time range used to specify when the behavior of the filtered insights started.
FromTime (datetime) --
The start time of the time range.
ToTime (datetime) --
The end time of the time range.
integer
The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
string
The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.
dict
Response Syntax
{
'ProactiveInsights': [
{
'Id': 'string',
'Name': 'string',
'Severity': 'LOW'|'MEDIUM'|'HIGH',
'Status': 'ONGOING'|'CLOSED',
'InsightTimeRange': {
'StartTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1)
},
'PredictionTimeRange': {
'StartTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1)
},
'ResourceCollection': {
'CloudFormation': {
'StackNames': [
'string',
]
},
'Tags': [
{
'AppBoundaryKey': 'string',
'TagValues': [
'string',
]
},
]
},
'ServiceCollection': {
'ServiceNames': [
'API_GATEWAY'|'APPLICATION_ELB'|'AUTO_SCALING_GROUP'|'CLOUD_FRONT'|'DYNAMO_DB'|'EC2'|'ECS'|'EKS'|'ELASTIC_BEANSTALK'|'ELASTI_CACHE'|'ELB'|'ES'|'KINESIS'|'LAMBDA'|'NAT_GATEWAY'|'NETWORK_ELB'|'RDS'|'REDSHIFT'|'ROUTE_53'|'S3'|'SAGE_MAKER'|'SNS'|'SQS'|'STEP_FUNCTIONS'|'SWF',
]
},
'AssociatedResourceArns': [
'string',
]
},
],
'ReactiveInsights': [
{
'Id': 'string',
'Name': 'string',
'Severity': 'LOW'|'MEDIUM'|'HIGH',
'Status': 'ONGOING'|'CLOSED',
'InsightTimeRange': {
'StartTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1)
},
'ResourceCollection': {
'CloudFormation': {
'StackNames': [
'string',
]
},
'Tags': [
{
'AppBoundaryKey': 'string',
'TagValues': [
'string',
]
},
]
},
'ServiceCollection': {
'ServiceNames': [
'API_GATEWAY'|'APPLICATION_ELB'|'AUTO_SCALING_GROUP'|'CLOUD_FRONT'|'DYNAMO_DB'|'EC2'|'ECS'|'EKS'|'ELASTIC_BEANSTALK'|'ELASTI_CACHE'|'ELB'|'ES'|'KINESIS'|'LAMBDA'|'NAT_GATEWAY'|'NETWORK_ELB'|'RDS'|'REDSHIFT'|'ROUTE_53'|'S3'|'SAGE_MAKER'|'SNS'|'SQS'|'STEP_FUNCTIONS'|'SWF',
]
},
'AssociatedResourceArns': [
'string',
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
ProactiveInsights (list) --
The returned list of proactive insights.
(dict) --
Details about a proactive insight. This object is returned by DescribeInsight.
Id (string) --
The ID of the proactive insight.
Name (string) --
The name of the proactive insight.
Severity (string) --
The severity of the insight. For more information, see Understanding insight severities in the Amazon DevOps Guru User Guide .
Status (string) --
The status of the proactive insight.
InsightTimeRange (dict) --
A time ranged that specifies when the observed behavior in an insight started and ended.
StartTime (datetime) --
The time when the behavior described in an insight started.
EndTime (datetime) --
The time when the behavior described in an insight ended.
PredictionTimeRange (dict) --
The time range during which anomalous behavior in a proactive anomaly or an insight is expected to occur.
StartTime (datetime) --
The time range during which a metric limit is expected to be exceeded. This applies to proactive insights only.
EndTime (datetime) --
The time when the behavior in a proactive insight is expected to end.
ResourceCollection (dict) --
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.
CloudFormation (dict) --
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.
StackNames (list) --
An array of CloudFormation stack names.
(string) --
Tags (list) --
The Amazon Web Services tags that are used by resources in the resource collection.
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.
Warning
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 . While keys are case-sensitive, the case of key characters don't matter to DevOps Guru. For example, DevOps Guru works with a key named devops-guru-rds and a key named DevOps-Guru-RDS . Possible key /value pairs in your application might be Devops-Guru-production-application/RDS or Devops-Guru-production-application/containers .
(dict) --
A collection of Amazon Web Services stags.
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.
Warning
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 . While keys are case-sensitive, the case of key characters don't matter to DevOps Guru. For example, DevOps Guru works with a key named devops-guru-rds and a key named DevOps-Guru-RDS . Possible key /value pairs in your application might be Devops-Guru-production-application/RDS or Devops-Guru-production-application/containers .
AppBoundaryKey (string) --
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.
Warning
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 . While keys are case-sensitive, the case of key characters don't matter to DevOps Guru. For example, DevOps Guru works with a key named devops-guru-rds and a key named DevOps-Guru-RDS . Possible key /value pairs in your application might be Devops-Guru-production-application/RDS or Devops-Guru-production-application/containers .
TagValues (list) --
The values in an Amazon Web Services tag collection.
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.
(string) --
ServiceCollection (dict) --
A collection of the names of Amazon Web Services services.
ServiceNames (list) --
An array of strings that each specifies the name of an Amazon Web Services service.
(string) --
AssociatedResourceArns (list) --
The Amazon Resource Names (ARNs) of the Amazon Web Services resources that generated this insight.
(string) --
ReactiveInsights (list) --
The returned list of reactive insights.
(dict) --
Information about a reactive insight. This object is returned by DescribeInsight.
Id (string) --
The ID of a reactive summary.
Name (string) --
The name of a reactive insight.
Severity (string) --
The severity of the insight. For more information, see Understanding insight severities in the Amazon DevOps Guru User Guide .
Status (string) --
The status of a reactive insight.
InsightTimeRange (dict) --
A time ranged that specifies when the observed behavior in an insight started and ended.
StartTime (datetime) --
The time when the behavior described in an insight started.
EndTime (datetime) --
The time when the behavior described in an insight ended.
ResourceCollection (dict) --
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.
CloudFormation (dict) --
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.
StackNames (list) --
An array of CloudFormation stack names.
(string) --
Tags (list) --
The Amazon Web Services tags that are used by resources in the resource collection.
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.
Warning
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 . While keys are case-sensitive, the case of key characters don't matter to DevOps Guru. For example, DevOps Guru works with a key named devops-guru-rds and a key named DevOps-Guru-RDS . Possible key /value pairs in your application might be Devops-Guru-production-application/RDS or Devops-Guru-production-application/containers .
(dict) --
A collection of Amazon Web Services stags.
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.
Warning
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 . While keys are case-sensitive, the case of key characters don't matter to DevOps Guru. For example, DevOps Guru works with a key named devops-guru-rds and a key named DevOps-Guru-RDS . Possible key /value pairs in your application might be Devops-Guru-production-application/RDS or Devops-Guru-production-application/containers .
AppBoundaryKey (string) --
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.
Warning
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 . While keys are case-sensitive, the case of key characters don't matter to DevOps Guru. For example, DevOps Guru works with a key named devops-guru-rds and a key named DevOps-Guru-RDS . Possible key /value pairs in your application might be Devops-Guru-production-application/RDS or Devops-Guru-production-application/containers .
TagValues (list) --
The values in an Amazon Web Services tag collection.
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.
(string) --
ServiceCollection (dict) --
A collection of the names of Amazon Web Services services.
ServiceNames (list) --
An array of strings that each specifies the name of an Amazon Web Services service.
(string) --
AssociatedResourceArns (list) --
The Amazon Resource Names (ARNs) of the Amazon Web Services resources that generated this insight.
(string) --
NextToken (string) --
The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.
{'ProactiveInsights': {'ResourceCollection': {'Tags': [{'AppBoundaryKey': 'string',
'TagValues': ['string']}]}},
'ReactiveInsights': {'ResourceCollection': {'Tags': [{'AppBoundaryKey': 'string',
'TagValues': ['string']}]}}}
Returns a list of insights associated with the account or OU Id.
See also: AWS API Documentation
Request Syntax
client.list_organization_insights(
StatusFilter={
'Ongoing': {
'Type': 'REACTIVE'|'PROACTIVE'
},
'Closed': {
'Type': 'REACTIVE'|'PROACTIVE',
'EndTimeRange': {
'FromTime': datetime(2015, 1, 1),
'ToTime': datetime(2015, 1, 1)
}
},
'Any': {
'Type': 'REACTIVE'|'PROACTIVE',
'StartTimeRange': {
'FromTime': datetime(2015, 1, 1),
'ToTime': datetime(2015, 1, 1)
}
}
},
MaxResults=123,
AccountIds=[
'string',
],
OrganizationalUnitIds=[
'string',
],
NextToken='string'
)
dict
[REQUIRED]
A filter used by ListInsights to specify which insights to return.
Ongoing (dict) --
A ListInsightsAnyStatusFilter that specifies ongoing insights that are either REACTIVE or PROACTIVE .
Type (string) -- [REQUIRED]
Use to filter for either REACTIVE or PROACTIVE insights.
Closed (dict) --
A ListInsightsClosedStatusFilter that specifies closed insights that are either REACTIVE or PROACTIVE .
Type (string) -- [REQUIRED]
Use to filter for either REACTIVE or PROACTIVE insights.
EndTimeRange (dict) -- [REQUIRED]
A time range used to specify when the behavior of the filtered insights ended.
FromTime (datetime) --
The earliest end time in the time range.
ToTime (datetime) --
The latest end time in the time range.
Any (dict) --
A ListInsightsAnyStatusFilter that specifies insights of any status that are either REACTIVE or PROACTIVE .
Type (string) -- [REQUIRED]
Use to filter for either REACTIVE or PROACTIVE insights.
StartTimeRange (dict) -- [REQUIRED]
A time range used to specify when the behavior of the filtered insights started.
FromTime (datetime) --
The start time of the time range.
ToTime (datetime) --
The end time of the time range.
integer
The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
list
The ID of the Amazon Web Services account.
(string) --
list
The ID of the organizational unit.
(string) --
string
The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.
dict
Response Syntax
{
'ProactiveInsights': [
{
'Id': 'string',
'AccountId': 'string',
'OrganizationalUnitId': 'string',
'Name': 'string',
'Severity': 'LOW'|'MEDIUM'|'HIGH',
'Status': 'ONGOING'|'CLOSED',
'InsightTimeRange': {
'StartTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1)
},
'PredictionTimeRange': {
'StartTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1)
},
'ResourceCollection': {
'CloudFormation': {
'StackNames': [
'string',
]
},
'Tags': [
{
'AppBoundaryKey': 'string',
'TagValues': [
'string',
]
},
]
},
'ServiceCollection': {
'ServiceNames': [
'API_GATEWAY'|'APPLICATION_ELB'|'AUTO_SCALING_GROUP'|'CLOUD_FRONT'|'DYNAMO_DB'|'EC2'|'ECS'|'EKS'|'ELASTIC_BEANSTALK'|'ELASTI_CACHE'|'ELB'|'ES'|'KINESIS'|'LAMBDA'|'NAT_GATEWAY'|'NETWORK_ELB'|'RDS'|'REDSHIFT'|'ROUTE_53'|'S3'|'SAGE_MAKER'|'SNS'|'SQS'|'STEP_FUNCTIONS'|'SWF',
]
}
},
],
'ReactiveInsights': [
{
'Id': 'string',
'AccountId': 'string',
'OrganizationalUnitId': 'string',
'Name': 'string',
'Severity': 'LOW'|'MEDIUM'|'HIGH',
'Status': 'ONGOING'|'CLOSED',
'InsightTimeRange': {
'StartTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1)
},
'ResourceCollection': {
'CloudFormation': {
'StackNames': [
'string',
]
},
'Tags': [
{
'AppBoundaryKey': 'string',
'TagValues': [
'string',
]
},
]
},
'ServiceCollection': {
'ServiceNames': [
'API_GATEWAY'|'APPLICATION_ELB'|'AUTO_SCALING_GROUP'|'CLOUD_FRONT'|'DYNAMO_DB'|'EC2'|'ECS'|'EKS'|'ELASTIC_BEANSTALK'|'ELASTI_CACHE'|'ELB'|'ES'|'KINESIS'|'LAMBDA'|'NAT_GATEWAY'|'NETWORK_ELB'|'RDS'|'REDSHIFT'|'ROUTE_53'|'S3'|'SAGE_MAKER'|'SNS'|'SQS'|'STEP_FUNCTIONS'|'SWF',
]
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
ProactiveInsights (list) --
An integer that specifies the number of open proactive insights in your Amazon Web Services account.
(dict) --
Details about a proactive insight. This object is returned by DescribeInsight .
Id (string) --
The ID of the insight summary.
AccountId (string) --
The ID of the Amazon Web Services account.
OrganizationalUnitId (string) --
The ID of the organizational unit.
Name (string) --
The name of the insight summary.
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 .
Status (string) --
An array of status values used to search for insights.
InsightTimeRange (dict) --
A time ranged that specifies when the observed behavior in an insight started and ended.
StartTime (datetime) --
The time when the behavior described in an insight started.
EndTime (datetime) --
The time when the behavior described in an insight ended.
PredictionTimeRange (dict) --
The time range during which anomalous behavior in a proactive anomaly or an insight is expected to occur.
StartTime (datetime) --
The time range during which a metric limit is expected to be exceeded. This applies to proactive insights only.
EndTime (datetime) --
The time when the behavior in a proactive insight is expected to end.
ResourceCollection (dict) --
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.
CloudFormation (dict) --
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.
StackNames (list) --
An array of CloudFormation stack names.
(string) --
Tags (list) --
The Amazon Web Services tags that are used by resources in the resource collection.
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.
Warning
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 . While keys are case-sensitive, the case of key characters don't matter to DevOps Guru. For example, DevOps Guru works with a key named devops-guru-rds and a key named DevOps-Guru-RDS . Possible key /value pairs in your application might be Devops-Guru-production-application/RDS or Devops-Guru-production-application/containers .
(dict) --
A collection of Amazon Web Services stags.
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.
Warning
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 . While keys are case-sensitive, the case of key characters don't matter to DevOps Guru. For example, DevOps Guru works with a key named devops-guru-rds and a key named DevOps-Guru-RDS . Possible key /value pairs in your application might be Devops-Guru-production-application/RDS or Devops-Guru-production-application/containers .
AppBoundaryKey (string) --
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.
Warning
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 . While keys are case-sensitive, the case of key characters don't matter to DevOps Guru. For example, DevOps Guru works with a key named devops-guru-rds and a key named DevOps-Guru-RDS . Possible key /value pairs in your application might be Devops-Guru-production-application/RDS or Devops-Guru-production-application/containers .
TagValues (list) --
The values in an Amazon Web Services tag collection.
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.
(string) --
ServiceCollection (dict) --
A collection of the names of Amazon Web Services services.
ServiceNames (list) --
An array of strings that each specifies the name of an Amazon Web Services service.
(string) --
ReactiveInsights (list) --
An integer that specifies the number of open reactive insights in your Amazon Web Services account.
(dict) --
Information about a reactive insight. This object is returned by DescribeInsight .
Id (string) --
The ID of the insight summary.
AccountId (string) --
The ID of the Amazon Web Services account.
OrganizationalUnitId (string) --
The ID of the organizational unit.
Name (string) --
The name of the insight summary.
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 .
Status (string) --
An array of status values used to search for insights.
InsightTimeRange (dict) --
A time ranged that specifies when the observed behavior in an insight started and ended.
StartTime (datetime) --
The time when the behavior described in an insight started.
EndTime (datetime) --
The time when the behavior described in an insight ended.
ResourceCollection (dict) --
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.
CloudFormation (dict) --
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.
StackNames (list) --
An array of CloudFormation stack names.
(string) --
Tags (list) --
The Amazon Web Services tags that are used by resources in the resource collection.
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.
Warning
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 . While keys are case-sensitive, the case of key characters don't matter to DevOps Guru. For example, DevOps Guru works with a key named devops-guru-rds and a key named DevOps-Guru-RDS . Possible key /value pairs in your application might be Devops-Guru-production-application/RDS or Devops-Guru-production-application/containers .
(dict) --
A collection of Amazon Web Services stags.
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.
Warning
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 . While keys are case-sensitive, the case of key characters don't matter to DevOps Guru. For example, DevOps Guru works with a key named devops-guru-rds and a key named DevOps-Guru-RDS . Possible key /value pairs in your application might be Devops-Guru-production-application/RDS or Devops-Guru-production-application/containers .
AppBoundaryKey (string) --
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.
Warning
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 . While keys are case-sensitive, the case of key characters don't matter to DevOps Guru. For example, DevOps Guru works with a key named devops-guru-rds and a key named DevOps-Guru-RDS . Possible key /value pairs in your application might be Devops-Guru-production-application/RDS or Devops-Guru-production-application/containers .
TagValues (list) --
The values in an Amazon Web Services tag collection.
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.
(string) --
ServiceCollection (dict) --
A collection of the names of Amazon Web Services services.
ServiceNames (list) --
An array of strings that each specifies the name of an Amazon Web Services service.
(string) --
NextToken (string) --
The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.
{'Recommendations': {'RelatedAnomalies': {'AnomalyId': 'string'}}}
Returns a list of a specified insight's recommendations. Each recommendation includes a list of related metrics and a list of related events.
See also: AWS API Documentation
Request Syntax
client.list_recommendations(
InsightId='string',
NextToken='string',
Locale='DE_DE'|'EN_US'|'EN_GB'|'ES_ES'|'FR_FR'|'IT_IT'|'JA_JP'|'KO_KR'|'PT_BR'|'ZH_CN'|'ZH_TW',
AccountId='string'
)
string
[REQUIRED]
The ID of the requested insight.
string
The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.
string
A locale that specifies the language to use for recommendations.
string
The ID of the Amazon Web Services account.
dict
Response Syntax
{
'Recommendations': [
{
'Description': 'string',
'Link': 'string',
'Name': 'string',
'Reason': 'string',
'RelatedEvents': [
{
'Name': 'string',
'Resources': [
{
'Name': 'string',
'Type': 'string'
},
]
},
],
'RelatedAnomalies': [
{
'Resources': [
{
'Name': 'string',
'Type': 'string'
},
],
'SourceDetails': [
{
'CloudWatchMetrics': [
{
'MetricName': 'string',
'Namespace': 'string'
},
]
},
],
'AnomalyId': 'string'
},
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Recommendations (list) --
An array of the requested recommendations.
(dict) --
Recommendation information to help you remediate detected anomalous behavior that generated an insight.
Description (string) --
A description of the problem.
Link (string) --
A hyperlink to information to help you address the problem.
Name (string) --
The name of the recommendation.
Reason (string) --
The reason DevOps Guru flagged the anomalous behavior as a problem.
RelatedEvents (list) --
Events that are related to the problem. Use these events to learn more about what's happening and to help address the issue.
(dict) --
Information about an event that is related to a recommendation.
Name (string) --
The name of the event. This corresponds to the Name field in an Event object.
Resources (list) --
A ResourceCollection object that contains arrays of the names of Amazon Web Services CloudFormation stacks. You can specify up to 500 Amazon Web Services CloudFormation stacks.
(dict) --
Information about an Amazon Web Services resource that emitted and event that is related to a recommendation in an insight.
Name (string) --
The name of the resource that emitted the event. This corresponds to the Name field in an EventResource object.
Type (string) --
The type of the resource that emitted the event. This corresponds to the Type field in an EventResource object.
RelatedAnomalies (list) --
Anomalies that are related to the problem. Use these Anomalies to learn more about what's happening and to help address the issue.
(dict) --
Information about an anomaly that is related to a recommendation.
Resources (list) --
An array of objects that represent resources in which DevOps Guru detected anomalous behavior. Each object contains the name and type of the resource.
(dict) --
Information about a resource in which DevOps Guru detected anomalous behavior.
Name (string) --
The name of the resource.
Type (string) --
The type of the resource. Resource types take the same form that is used by Amazon Web Services CloudFormation resource type identifiers, service-provider::service-name::data-type-name . For example, AWS::RDS::DBCluster . For more information, see Amazon Web Services resource and property types reference in the Amazon Web Services CloudFormation User Guide .
SourceDetails (list) --
Information about where the anomalous behavior related the recommendation was found. For example, details in Amazon CloudWatch metrics.
(dict) --
Contains an array of RecommendationRelatedCloudWatchMetricsSourceDetail objects that contain the name and namespace of an Amazon CloudWatch metric.
CloudWatchMetrics (list) --
An array of CloudWatchMetricsDetail objects that contains information about the analyzed metrics that displayed anomalous behavior.
(dict) --
Information about an Amazon CloudWatch metric that is analyzed by DevOps Guru. It is one of many analyzed metrics that are used to generate insights.
MetricName (string) --
The name of the CloudWatch metric.
Namespace (string) --
The namespace of the CloudWatch metric. A namespace is a container for CloudWatch metrics.
AnomalyId (string) --
The ID of an anomaly that generated the insight with this recommendation.
NextToken (string) --
The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.
{'Filters': {'ResourceCollection': {'Tags': [{'AppBoundaryKey': 'string',
'TagValues': ['string']}]}}}
Response {'ProactiveInsights': {'AssociatedResourceArns': ['string'],
'ResourceCollection': {'Tags': [{'AppBoundaryKey': 'string',
'TagValues': ['string']}]}},
'ReactiveInsights': {'AssociatedResourceArns': ['string'],
'ResourceCollection': {'Tags': [{'AppBoundaryKey': 'string',
'TagValues': ['string']}]}}}
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 , 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.
See also: AWS API Documentation
Request Syntax
client.search_insights(
StartTimeRange={
'FromTime': datetime(2015, 1, 1),
'ToTime': datetime(2015, 1, 1)
},
Filters={
'Severities': [
'LOW'|'MEDIUM'|'HIGH',
],
'Statuses': [
'ONGOING'|'CLOSED',
],
'ResourceCollection': {
'CloudFormation': {
'StackNames': [
'string',
]
},
'Tags': [
{
'AppBoundaryKey': 'string',
'TagValues': [
'string',
]
},
]
},
'ServiceCollection': {
'ServiceNames': [
'API_GATEWAY'|'APPLICATION_ELB'|'AUTO_SCALING_GROUP'|'CLOUD_FRONT'|'DYNAMO_DB'|'EC2'|'ECS'|'EKS'|'ELASTIC_BEANSTALK'|'ELASTI_CACHE'|'ELB'|'ES'|'KINESIS'|'LAMBDA'|'NAT_GATEWAY'|'NETWORK_ELB'|'RDS'|'REDSHIFT'|'ROUTE_53'|'S3'|'SAGE_MAKER'|'SNS'|'SQS'|'STEP_FUNCTIONS'|'SWF',
]
}
},
MaxResults=123,
NextToken='string',
Type='REACTIVE'|'PROACTIVE'
)
dict
[REQUIRED]
The start of the time range passed in. Returned insights occurred after this time.
FromTime (datetime) --
The start time of the time range.
ToTime (datetime) --
The end time of the time range.
dict
A SearchInsightsFilters object that is used to set the severity and status filters on your insight search.
Severities (list) --
An array of severity values used to search for insights.
(string) --
Statuses (list) --
An array of status values used to search for insights.
(string) --
ResourceCollection (dict) --
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.
CloudFormation (dict) --
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.
StackNames (list) --
An array of CloudFormation stack names.
(string) --
Tags (list) --
The Amazon Web Services tags that are used by resources in the resource collection.
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.
Warning
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 . While keys are case-sensitive, the case of key characters don't matter to DevOps Guru. For example, DevOps Guru works with a key named devops-guru-rds and a key named DevOps-Guru-RDS . Possible key /value pairs in your application might be Devops-Guru-production-application/RDS or Devops-Guru-production-application/containers .
(dict) --
A collection of Amazon Web Services stags.
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.
Warning
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 . While keys are case-sensitive, the case of key characters don't matter to DevOps Guru. For example, DevOps Guru works with a key named devops-guru-rds and a key named DevOps-Guru-RDS . Possible key /value pairs in your application might be Devops-Guru-production-application/RDS or Devops-Guru-production-application/containers .
AppBoundaryKey (string) -- [REQUIRED]
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.
Warning
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 . While keys are case-sensitive, the case of key characters don't matter to DevOps Guru. For example, DevOps Guru works with a key named devops-guru-rds and a key named DevOps-Guru-RDS . Possible key /value pairs in your application might be Devops-Guru-production-application/RDS or Devops-Guru-production-application/containers .
TagValues (list) -- [REQUIRED]
The values in an Amazon Web Services tag collection.
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.
(string) --
ServiceCollection (dict) --
A collection of the names of Amazon Web Services services.
ServiceNames (list) --
An array of strings that each specifies the name of an Amazon Web Services service.
(string) --
integer
The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
string
The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.
string
[REQUIRED]
The type of insights you are searching for ( REACTIVE or PROACTIVE ).
dict
Response Syntax
{
'ProactiveInsights': [
{
'Id': 'string',
'Name': 'string',
'Severity': 'LOW'|'MEDIUM'|'HIGH',
'Status': 'ONGOING'|'CLOSED',
'InsightTimeRange': {
'StartTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1)
},
'PredictionTimeRange': {
'StartTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1)
},
'ResourceCollection': {
'CloudFormation': {
'StackNames': [
'string',
]
},
'Tags': [
{
'AppBoundaryKey': 'string',
'TagValues': [
'string',
]
},
]
},
'ServiceCollection': {
'ServiceNames': [
'API_GATEWAY'|'APPLICATION_ELB'|'AUTO_SCALING_GROUP'|'CLOUD_FRONT'|'DYNAMO_DB'|'EC2'|'ECS'|'EKS'|'ELASTIC_BEANSTALK'|'ELASTI_CACHE'|'ELB'|'ES'|'KINESIS'|'LAMBDA'|'NAT_GATEWAY'|'NETWORK_ELB'|'RDS'|'REDSHIFT'|'ROUTE_53'|'S3'|'SAGE_MAKER'|'SNS'|'SQS'|'STEP_FUNCTIONS'|'SWF',
]
},
'AssociatedResourceArns': [
'string',
]
},
],
'ReactiveInsights': [
{
'Id': 'string',
'Name': 'string',
'Severity': 'LOW'|'MEDIUM'|'HIGH',
'Status': 'ONGOING'|'CLOSED',
'InsightTimeRange': {
'StartTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1)
},
'ResourceCollection': {
'CloudFormation': {
'StackNames': [
'string',
]
},
'Tags': [
{
'AppBoundaryKey': 'string',
'TagValues': [
'string',
]
},
]
},
'ServiceCollection': {
'ServiceNames': [
'API_GATEWAY'|'APPLICATION_ELB'|'AUTO_SCALING_GROUP'|'CLOUD_FRONT'|'DYNAMO_DB'|'EC2'|'ECS'|'EKS'|'ELASTIC_BEANSTALK'|'ELASTI_CACHE'|'ELB'|'ES'|'KINESIS'|'LAMBDA'|'NAT_GATEWAY'|'NETWORK_ELB'|'RDS'|'REDSHIFT'|'ROUTE_53'|'S3'|'SAGE_MAKER'|'SNS'|'SQS'|'STEP_FUNCTIONS'|'SWF',
]
},
'AssociatedResourceArns': [
'string',
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
ProactiveInsights (list) --
The returned proactive insights.
(dict) --
Details about a proactive insight. This object is returned by DescribeInsight.
Id (string) --
The ID of the proactive insight.
Name (string) --
The name of the proactive insight.
Severity (string) --
The severity of the insight. For more information, see Understanding insight severities in the Amazon DevOps Guru User Guide .
Status (string) --
The status of the proactive insight.
InsightTimeRange (dict) --
A time ranged that specifies when the observed behavior in an insight started and ended.
StartTime (datetime) --
The time when the behavior described in an insight started.
EndTime (datetime) --
The time when the behavior described in an insight ended.
PredictionTimeRange (dict) --
The time range during which anomalous behavior in a proactive anomaly or an insight is expected to occur.
StartTime (datetime) --
The time range during which a metric limit is expected to be exceeded. This applies to proactive insights only.
EndTime (datetime) --
The time when the behavior in a proactive insight is expected to end.
ResourceCollection (dict) --
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.
CloudFormation (dict) --
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.
StackNames (list) --
An array of CloudFormation stack names.
(string) --
Tags (list) --
The Amazon Web Services tags that are used by resources in the resource collection.
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.
Warning
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 . While keys are case-sensitive, the case of key characters don't matter to DevOps Guru. For example, DevOps Guru works with a key named devops-guru-rds and a key named DevOps-Guru-RDS . Possible key /value pairs in your application might be Devops-Guru-production-application/RDS or Devops-Guru-production-application/containers .
(dict) --
A collection of Amazon Web Services stags.
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.
Warning
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 . While keys are case-sensitive, the case of key characters don't matter to DevOps Guru. For example, DevOps Guru works with a key named devops-guru-rds and a key named DevOps-Guru-RDS . Possible key /value pairs in your application might be Devops-Guru-production-application/RDS or Devops-Guru-production-application/containers .
AppBoundaryKey (string) --
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.
Warning
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 . While keys are case-sensitive, the case of key characters don't matter to DevOps Guru. For example, DevOps Guru works with a key named devops-guru-rds and a key named DevOps-Guru-RDS . Possible key /value pairs in your application might be Devops-Guru-production-application/RDS or Devops-Guru-production-application/containers .
TagValues (list) --
The values in an Amazon Web Services tag collection.
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.
(string) --
ServiceCollection (dict) --
A collection of the names of Amazon Web Services services.
ServiceNames (list) --
An array of strings that each specifies the name of an Amazon Web Services service.
(string) --
AssociatedResourceArns (list) --
The Amazon Resource Names (ARNs) of the Amazon Web Services resources that generated this insight.
(string) --
ReactiveInsights (list) --
The returned reactive insights.
(dict) --
Information about a reactive insight. This object is returned by DescribeInsight.
Id (string) --
The ID of a reactive summary.
Name (string) --
The name of a reactive insight.
Severity (string) --
The severity of the insight. For more information, see Understanding insight severities in the Amazon DevOps Guru User Guide .
Status (string) --
The status of a reactive insight.
InsightTimeRange (dict) --
A time ranged that specifies when the observed behavior in an insight started and ended.
StartTime (datetime) --
The time when the behavior described in an insight started.
EndTime (datetime) --
The time when the behavior described in an insight ended.
ResourceCollection (dict) --
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.
CloudFormation (dict) --
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.
StackNames (list) --
An array of CloudFormation stack names.
(string) --
Tags (list) --
The Amazon Web Services tags that are used by resources in the resource collection.
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.
Warning
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 . While keys are case-sensitive, the case of key characters don't matter to DevOps Guru. For example, DevOps Guru works with a key named devops-guru-rds and a key named DevOps-Guru-RDS . Possible key /value pairs in your application might be Devops-Guru-production-application/RDS or Devops-Guru-production-application/containers .
(dict) --
A collection of Amazon Web Services stags.
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.
Warning
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 . While keys are case-sensitive, the case of key characters don't matter to DevOps Guru. For example, DevOps Guru works with a key named devops-guru-rds and a key named DevOps-Guru-RDS . Possible key /value pairs in your application might be Devops-Guru-production-application/RDS or Devops-Guru-production-application/containers .
AppBoundaryKey (string) --
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.
Warning
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 . While keys are case-sensitive, the case of key characters don't matter to DevOps Guru. For example, DevOps Guru works with a key named devops-guru-rds and a key named DevOps-Guru-RDS . Possible key /value pairs in your application might be Devops-Guru-production-application/RDS or Devops-Guru-production-application/containers .
TagValues (list) --
The values in an Amazon Web Services tag collection.
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.
(string) --
ServiceCollection (dict) --
A collection of the names of Amazon Web Services services.
ServiceNames (list) --
An array of strings that each specifies the name of an Amazon Web Services service.
(string) --
AssociatedResourceArns (list) --
The Amazon Resource Names (ARNs) of the Amazon Web Services resources that generated this insight.
(string) --
NextToken (string) --
The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.
{'Filters': {'ResourceCollection': {'Tags': [{'AppBoundaryKey': 'string',
'TagValues': ['string']}]}}}
Response {'ProactiveInsights': {'AssociatedResourceArns': ['string'],
'ResourceCollection': {'Tags': [{'AppBoundaryKey': 'string',
'TagValues': ['string']}]}},
'ReactiveInsights': {'AssociatedResourceArns': ['string'],
'ResourceCollection': {'Tags': [{'AppBoundaryKey': 'string',
'TagValues': ['string']}]}}}
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.
See also: AWS API Documentation
Request Syntax
client.search_organization_insights(
AccountIds=[
'string',
],
StartTimeRange={
'FromTime': datetime(2015, 1, 1),
'ToTime': datetime(2015, 1, 1)
},
Filters={
'Severities': [
'LOW'|'MEDIUM'|'HIGH',
],
'Statuses': [
'ONGOING'|'CLOSED',
],
'ResourceCollection': {
'CloudFormation': {
'StackNames': [
'string',
]
},
'Tags': [
{
'AppBoundaryKey': 'string',
'TagValues': [
'string',
]
},
]
},
'ServiceCollection': {
'ServiceNames': [
'API_GATEWAY'|'APPLICATION_ELB'|'AUTO_SCALING_GROUP'|'CLOUD_FRONT'|'DYNAMO_DB'|'EC2'|'ECS'|'EKS'|'ELASTIC_BEANSTALK'|'ELASTI_CACHE'|'ELB'|'ES'|'KINESIS'|'LAMBDA'|'NAT_GATEWAY'|'NETWORK_ELB'|'RDS'|'REDSHIFT'|'ROUTE_53'|'S3'|'SAGE_MAKER'|'SNS'|'SQS'|'STEP_FUNCTIONS'|'SWF',
]
}
},
MaxResults=123,
NextToken='string',
Type='REACTIVE'|'PROACTIVE'
)
list
[REQUIRED]
The ID of the Amazon Web Services account.
(string) --
dict
[REQUIRED]
A time range used to specify when the behavior of an insight or anomaly started.
FromTime (datetime) --
The start time of the time range.
ToTime (datetime) --
The end time of the time range.
dict
A SearchOrganizationInsightsFilters object that is used to set the severity and status filters on your insight search.
Severities (list) --
An array of severity values used to search for insights.
(string) --
Statuses (list) --
An array of status values used to search for insights.
(string) --
ResourceCollection (dict) --
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.
CloudFormation (dict) --
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.
StackNames (list) --
An array of CloudFormation stack names.
(string) --
Tags (list) --
The Amazon Web Services tags that are used by resources in the resource collection.
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.
Warning
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 . While keys are case-sensitive, the case of key characters don't matter to DevOps Guru. For example, DevOps Guru works with a key named devops-guru-rds and a key named DevOps-Guru-RDS . Possible key /value pairs in your application might be Devops-Guru-production-application/RDS or Devops-Guru-production-application/containers .
(dict) --
A collection of Amazon Web Services stags.
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.
Warning
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 . While keys are case-sensitive, the case of key characters don't matter to DevOps Guru. For example, DevOps Guru works with a key named devops-guru-rds and a key named DevOps-Guru-RDS . Possible key /value pairs in your application might be Devops-Guru-production-application/RDS or Devops-Guru-production-application/containers .
AppBoundaryKey (string) -- [REQUIRED]
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.
Warning
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 . While keys are case-sensitive, the case of key characters don't matter to DevOps Guru. For example, DevOps Guru works with a key named devops-guru-rds and a key named DevOps-Guru-RDS . Possible key /value pairs in your application might be Devops-Guru-production-application/RDS or Devops-Guru-production-application/containers .
TagValues (list) -- [REQUIRED]
The values in an Amazon Web Services tag collection.
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.
(string) --
ServiceCollection (dict) --
A collection of the names of Amazon Web Services services.
ServiceNames (list) --
An array of strings that each specifies the name of an Amazon Web Services service.
(string) --
integer
The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
string
The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.
string
[REQUIRED]
The type of insights you are searching for ( REACTIVE or PROACTIVE ).
dict
Response Syntax
{
'ProactiveInsights': [
{
'Id': 'string',
'Name': 'string',
'Severity': 'LOW'|'MEDIUM'|'HIGH',
'Status': 'ONGOING'|'CLOSED',
'InsightTimeRange': {
'StartTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1)
},
'PredictionTimeRange': {
'StartTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1)
},
'ResourceCollection': {
'CloudFormation': {
'StackNames': [
'string',
]
},
'Tags': [
{
'AppBoundaryKey': 'string',
'TagValues': [
'string',
]
},
]
},
'ServiceCollection': {
'ServiceNames': [
'API_GATEWAY'|'APPLICATION_ELB'|'AUTO_SCALING_GROUP'|'CLOUD_FRONT'|'DYNAMO_DB'|'EC2'|'ECS'|'EKS'|'ELASTIC_BEANSTALK'|'ELASTI_CACHE'|'ELB'|'ES'|'KINESIS'|'LAMBDA'|'NAT_GATEWAY'|'NETWORK_ELB'|'RDS'|'REDSHIFT'|'ROUTE_53'|'S3'|'SAGE_MAKER'|'SNS'|'SQS'|'STEP_FUNCTIONS'|'SWF',
]
},
'AssociatedResourceArns': [
'string',
]
},
],
'ReactiveInsights': [
{
'Id': 'string',
'Name': 'string',
'Severity': 'LOW'|'MEDIUM'|'HIGH',
'Status': 'ONGOING'|'CLOSED',
'InsightTimeRange': {
'StartTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1)
},
'ResourceCollection': {
'CloudFormation': {
'StackNames': [
'string',
]
},
'Tags': [
{
'AppBoundaryKey': 'string',
'TagValues': [
'string',
]
},
]
},
'ServiceCollection': {
'ServiceNames': [
'API_GATEWAY'|'APPLICATION_ELB'|'AUTO_SCALING_GROUP'|'CLOUD_FRONT'|'DYNAMO_DB'|'EC2'|'ECS'|'EKS'|'ELASTIC_BEANSTALK'|'ELASTI_CACHE'|'ELB'|'ES'|'KINESIS'|'LAMBDA'|'NAT_GATEWAY'|'NETWORK_ELB'|'RDS'|'REDSHIFT'|'ROUTE_53'|'S3'|'SAGE_MAKER'|'SNS'|'SQS'|'STEP_FUNCTIONS'|'SWF',
]
},
'AssociatedResourceArns': [
'string',
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
ProactiveInsights (list) --
An integer that specifies the number of open proactive insights in your Amazon Web Services account.
(dict) --
Details about a proactive insight. This object is returned by DescribeInsight.
Id (string) --
The ID of the proactive insight.
Name (string) --
The name of the proactive insight.
Severity (string) --
The severity of the insight. For more information, see Understanding insight severities in the Amazon DevOps Guru User Guide .
Status (string) --
The status of the proactive insight.
InsightTimeRange (dict) --
A time ranged that specifies when the observed behavior in an insight started and ended.
StartTime (datetime) --
The time when the behavior described in an insight started.
EndTime (datetime) --
The time when the behavior described in an insight ended.
PredictionTimeRange (dict) --
The time range during which anomalous behavior in a proactive anomaly or an insight is expected to occur.
StartTime (datetime) --
The time range during which a metric limit is expected to be exceeded. This applies to proactive insights only.
EndTime (datetime) --
The time when the behavior in a proactive insight is expected to end.
ResourceCollection (dict) --
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.
CloudFormation (dict) --
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.
StackNames (list) --
An array of CloudFormation stack names.
(string) --
Tags (list) --
The Amazon Web Services tags that are used by resources in the resource collection.
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.
Warning
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 . While keys are case-sensitive, the case of key characters don't matter to DevOps Guru. For example, DevOps Guru works with a key named devops-guru-rds and a key named DevOps-Guru-RDS . Possible key /value pairs in your application might be Devops-Guru-production-application/RDS or Devops-Guru-production-application/containers .
(dict) --
A collection of Amazon Web Services stags.
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.
Warning
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 . While keys are case-sensitive, the case of key characters don't matter to DevOps Guru. For example, DevOps Guru works with a key named devops-guru-rds and a key named DevOps-Guru-RDS . Possible key /value pairs in your application might be Devops-Guru-production-application/RDS or Devops-Guru-production-application/containers .
AppBoundaryKey (string) --
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.
Warning
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 . While keys are case-sensitive, the case of key characters don't matter to DevOps Guru. For example, DevOps Guru works with a key named devops-guru-rds and a key named DevOps-Guru-RDS . Possible key /value pairs in your application might be Devops-Guru-production-application/RDS or Devops-Guru-production-application/containers .
TagValues (list) --
The values in an Amazon Web Services tag collection.
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.
(string) --
ServiceCollection (dict) --
A collection of the names of Amazon Web Services services.
ServiceNames (list) --
An array of strings that each specifies the name of an Amazon Web Services service.
(string) --
AssociatedResourceArns (list) --
The Amazon Resource Names (ARNs) of the Amazon Web Services resources that generated this insight.
(string) --
ReactiveInsights (list) --
An integer that specifies the number of open reactive insights in your Amazon Web Services account.
(dict) --
Information about a reactive insight. This object is returned by DescribeInsight.
Id (string) --
The ID of a reactive summary.
Name (string) --
The name of a reactive insight.
Severity (string) --
The severity of the insight. For more information, see Understanding insight severities in the Amazon DevOps Guru User Guide .
Status (string) --
The status of a reactive insight.
InsightTimeRange (dict) --
A time ranged that specifies when the observed behavior in an insight started and ended.
StartTime (datetime) --
The time when the behavior described in an insight started.
EndTime (datetime) --
The time when the behavior described in an insight ended.
ResourceCollection (dict) --
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.
CloudFormation (dict) --
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.
StackNames (list) --
An array of CloudFormation stack names.
(string) --
Tags (list) --
The Amazon Web Services tags that are used by resources in the resource collection.
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.
Warning
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 . While keys are case-sensitive, the case of key characters don't matter to DevOps Guru. For example, DevOps Guru works with a key named devops-guru-rds and a key named DevOps-Guru-RDS . Possible key /value pairs in your application might be Devops-Guru-production-application/RDS or Devops-Guru-production-application/containers .
(dict) --
A collection of Amazon Web Services stags.
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.
Warning
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 . While keys are case-sensitive, the case of key characters don't matter to DevOps Guru. For example, DevOps Guru works with a key named devops-guru-rds and a key named DevOps-Guru-RDS . Possible key /value pairs in your application might be Devops-Guru-production-application/RDS or Devops-Guru-production-application/containers .
AppBoundaryKey (string) --
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.
Warning
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 . While keys are case-sensitive, the case of key characters don't matter to DevOps Guru. For example, DevOps Guru works with a key named devops-guru-rds and a key named DevOps-Guru-RDS . Possible key /value pairs in your application might be Devops-Guru-production-application/RDS or Devops-Guru-production-application/containers .
TagValues (list) --
The values in an Amazon Web Services tag collection.
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.
(string) --
ServiceCollection (dict) --
A collection of the names of Amazon Web Services services.
ServiceNames (list) --
An array of strings that each specifies the name of an Amazon Web Services service.
(string) --
AssociatedResourceArns (list) --
The Amazon Resource Names (ARNs) of the Amazon Web Services resources that generated this insight.
(string) --
NextToken (string) --
The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.
{'ResourceCollection': {'Tags': [{'AppBoundaryKey': 'string',
'TagValues': ['string']}]}}
Starts the creation of an estimate of the monthly cost to analyze your Amazon Web Services resources.
See also: AWS API Documentation
Request Syntax
client.start_cost_estimation(
ResourceCollection={
'CloudFormation': {
'StackNames': [
'string',
]
},
'Tags': [
{
'AppBoundaryKey': 'string',
'TagValues': [
'string',
]
},
]
},
ClientToken='string'
)
dict
[REQUIRED]
The collection of Amazon Web Services resources used to create a monthly DevOps Guru cost estimate.
CloudFormation (dict) --
An object that specifies the CloudFormation stack that defines the Amazon Web Services resources used to create a monthly estimate for DevOps Guru.
StackNames (list) --
An array of CloudFormation stack names. Its size is fixed at 1 item.
(string) --
Tags (list) --
The Amazon Web Services tags used to filter the resource collection that is used for a cost estimate.
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.
Warning
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 . While keys are case-sensitive, the case of key characters don't matter to DevOps Guru. For example, DevOps Guru works with a key named devops-guru-rds and a key named DevOps-Guru-RDS . Possible key /value pairs in your application might be Devops-Guru-production-application/RDS or Devops-Guru-production-application/containers .
(dict) --
Information about a collection of Amazon Web Services resources that are identified by an Amazon Web Services tag. This collection of resources is used to create a monthly cost estimate for DevOps Guru to analyze Amazon Web Services resources. The maximum number of tags you can specify for a cost estimate is one. The estimate created is for the cost to analyze the Amazon Web Services resources defined by the tag. For more information, see Stacks in the Amazon Web Services CloudFormation User Guide .
AppBoundaryKey (string) -- [REQUIRED]
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.
Warning
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 . While keys are case-sensitive, the case of key characters don't matter to DevOps Guru. For example, DevOps Guru works with a key named devops-guru-rds and a key named DevOps-Guru-RDS . Possible key /value pairs in your application might be Devops-Guru-production-application/RDS or Devops-Guru-production-application/containers .
TagValues (list) -- [REQUIRED]
The values in an Amazon Web Services tag collection.
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.
(string) --
string
The idempotency token used to identify each cost estimate request.
This field is autopopulated if not provided.
dict
Response Syntax
{}
Response Structure
(dict) --
{'ResourceCollection': {'Tags': [{'AppBoundaryKey': 'string',
'TagValues': ['string']}]}}
Updates the collection of resources that DevOps Guru analyzes. 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. This method also creates the IAM role required for you to use DevOps Guru.
See also: AWS API Documentation
Request Syntax
client.update_resource_collection(
Action='ADD'|'REMOVE',
ResourceCollection={
'CloudFormation': {
'StackNames': [
'string',
]
},
'Tags': [
{
'AppBoundaryKey': 'string',
'TagValues': [
'string',
]
},
]
}
)
string
[REQUIRED]
Specifies if the resource collection in the request is added or deleted to the resource collection.
dict
[REQUIRED]
Contains information used to update a collection of Amazon Web Services resources.
CloudFormation (dict) --
A collection of Amazon Web Services CloudFormation stacks. You can specify up to 500 Amazon Web Services CloudFormation stacks.
StackNames (list) --
An array of the names of the Amazon Web Services CloudFormation stacks to update. You can specify up to 500 Amazon Web Services CloudFormation stacks.
(string) --
Tags (list) --
The updated Amazon Web Services tags used to filter the resources in the resource collection.
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.
Warning
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 . While keys are case-sensitive, the case of key characters don't matter to DevOps Guru. For example, DevOps Guru works with a key named devops-guru-rds and a key named DevOps-Guru-RDS . Possible key /value pairs in your application might be Devops-Guru-production-application/RDS or Devops-Guru-production-application/containers .
(dict) --
A new collection of Amazon Web Services resources that are defined by an Amazon Web Services tag or tag key /value pair.
AppBoundaryKey (string) -- [REQUIRED]
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.
Warning
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 . While keys are case-sensitive, the case of key characters don't matter to DevOps Guru. For example, DevOps Guru works with a key named devops-guru-rds and a key named DevOps-Guru-RDS . Possible key /value pairs in your application might be Devops-Guru-production-application/RDS or Devops-Guru-production-application/containers .
TagValues (list) -- [REQUIRED]
The values in an Amazon Web Services tag collection.
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.
(string) --
dict
Response Syntax
{}
Response Structure
(dict) --