2021/07/08 - Amazon DevOps Guru - 2 updated api methods
Changes Add AnomalyReportedTimeRange field to include open and close time of anomalies.
{'ProactiveAnomaly': {'AnomalyReportedTimeRange': {'CloseTime': 'timestamp',
'OpenTime': 'timestamp'}},
'ReactiveAnomaly': {'AnomalyReportedTimeRange': {'CloseTime': 'timestamp',
'OpenTime': 'timestamp'}}}
Returns details about an anomaly that you specify using its ID.
See also: AWS API Documentation
Request Syntax
client.describe_anomaly(
Id='string'
)
string
[REQUIRED]
The ID of the anomaly.
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
},
]
},
'AssociatedInsightId': 'string',
'ResourceCollection': {
'CloudFormation': {
'StackNames': [
'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
},
]
},
'AssociatedInsightId': 'string',
'ResourceCollection': {
'CloudFormation': {
'StackNames': [
'string',
]
}
}
}
}
Response Structure
(dict) --
ProactiveAnomaly (dict) --
A ReactiveAnomaly object that represents the requested anomaly.
Id (string) --
The ID of a proactive anomaly.
Severity (string) --
The severity of a proactive anomaly.
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) --
A 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 object that contains information about the analyzed metrics that displayed 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 a 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.
AssociatedInsightId (string) --
The ID of the insight that contains this anomaly. An insight is composed of related anomalies.
ResourceCollection (dict) --
A collection of AWS resources supported by DevOps Guru. The one type of AWS resource collection supported is AWS CloudFormation stacks. DevOps Guru can be configured to analyze only the AWS resources that are defined in the stacks. You can specify up to 500 AWS CloudFormation stacks.
CloudFormation (dict) --
An array of the names of AWS CloudFormation stacks. The stacks define AWS resources that DevOps Guru analyzes. You can specify up to 500 AWS CloudFormation stacks.
StackNames (list) --
An array of CloudFormation stack names.
(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 ProactiveAnomaly object that represents the requested anomaly.
Id (string) --
The ID of the reactive anomaly.
Severity (string) --
The severity of the anomaly.
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) --
A 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 object that contains information about the analyzed metrics that displayed 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 a 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.
AssociatedInsightId (string) --
The ID of the insight that contains this anomaly. An insight is composed of related anomalies.
ResourceCollection (dict) --
A collection of AWS resources supported by DevOps Guru. The one type of AWS resource collection supported is AWS CloudFormation stacks. DevOps Guru can be configured to analyze only the AWS resources that are defined in the stacks. You can specify up to 500 AWS CloudFormation stacks.
CloudFormation (dict) --
An array of the names of AWS CloudFormation stacks. The stacks define AWS resources that DevOps Guru analyzes. You can specify up to 500 AWS CloudFormation stacks.
StackNames (list) --
An array of CloudFormation stack names.
(string) --
{'ProactiveAnomalies': {'AnomalyReportedTimeRange': {'CloseTime': 'timestamp',
'OpenTime': 'timestamp'}},
'ReactiveAnomalies': {'AnomalyReportedTimeRange': {'CloseTime': 'timestamp',
'OpenTime': 'timestamp'}}}
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'
)
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.
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
},
]
},
'AssociatedInsightId': 'string',
'ResourceCollection': {
'CloudFormation': {
'StackNames': [
'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
},
]
},
'AssociatedInsightId': 'string',
'ResourceCollection': {
'CloudFormation': {
'StackNames': [
'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.
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) --
A 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 object that contains information about the analyzed metrics that displayed 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 a 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.
AssociatedInsightId (string) --
The ID of the insight that contains this anomaly. An insight is composed of related anomalies.
ResourceCollection (dict) --
A collection of AWS resources supported by DevOps Guru. The one type of AWS resource collection supported is AWS CloudFormation stacks. DevOps Guru can be configured to analyze only the AWS resources that are defined in the stacks. You can specify up to 500 AWS CloudFormation stacks.
CloudFormation (dict) --
An array of the names of AWS CloudFormation stacks. The stacks define AWS resources that DevOps Guru analyzes. You can specify up to 500 AWS CloudFormation stacks.
StackNames (list) --
An array of CloudFormation stack names.
(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 reactive anomaly.
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) --
A 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 object that contains information about the analyzed metrics that displayed 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 a 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.
AssociatedInsightId (string) --
The ID of the insight that contains this anomaly. An insight is composed of related anomalies.
ResourceCollection (dict) --
A collection of AWS resources supported by DevOps Guru. The one type of AWS resource collection supported is AWS CloudFormation stacks. DevOps Guru can be configured to analyze only the AWS resources that are defined in the stacks. You can specify up to 500 AWS CloudFormation stacks.
CloudFormation (dict) --
An array of the names of AWS CloudFormation stacks. The stacks define AWS resources that DevOps Guru analyzes. You can specify up to 500 AWS CloudFormation stacks.
StackNames (list) --
An array of CloudFormation stack names.
(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.