DescribeAnomaly - Amazon DevOps Guru

DescribeAnomaly

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

Request Syntax

GET /anomalies/Id?AccountId=AccountId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

AccountId

The ID of the member account.

Length Constraints: Fixed length of 12.

Pattern: ^\d{12}$

Id

The ID of the anomaly.

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: ^[\w~.-]*$

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "ProactiveAnomaly": { "AnomalyReportedTimeRange": { "CloseTime": number, "OpenTime": number }, "AnomalyResources": [ { "Name": "string", "Type": "string" } ], "AnomalyTimeRange": { "EndTime": number, "StartTime": number }, "AssociatedInsightId": "string", "Id": "string", "Limit": number, "PredictionTimeRange": { "EndTime": number, "StartTime": number }, "ResourceCollection": { "CloudFormation": { "StackNames": [ "string" ] }, "Tags": [ { "AppBoundaryKey": "string", "TagValues": [ "string" ] } ] }, "Severity": "string", "SourceDetails": { "CloudWatchMetrics": [ { "Dimensions": [ { "Name": "string", "Value": "string" } ], "MetricDataSummary": { "StatusCode": "string", "TimestampMetricValuePairList": [ { "MetricValue": number, "Timestamp": number } ] }, "MetricName": "string", "Namespace": "string", "Period": number, "Stat": "string", "Unit": "string" } ], "PerformanceInsightsMetrics": [ { "MetricDisplayName": "string", "MetricQuery": { "Filter": { "string" : "string" }, "GroupBy": { "Dimensions": [ "string" ], "Group": "string", "Limit": number }, "Metric": "string" }, "ReferenceData": [ { "ComparisonValues": { "ReferenceMetric": { "MetricQuery": { "Filter": { "string" : "string" }, "GroupBy": { "Dimensions": [ "string" ], "Group": "string", "Limit": number }, "Metric": "string" } }, "ReferenceScalar": { "Value": number } }, "Name": "string" } ], "StatsAtAnomaly": [ { "Type": "string", "Value": number } ], "StatsAtBaseline": [ { "Type": "string", "Value": number } ], "Unit": "string" } ] }, "SourceMetadata": { "Source": "string", "SourceResourceName": "string", "SourceResourceType": "string" }, "Status": "string", "UpdateTime": number }, "ReactiveAnomaly": { "AnomalyReportedTimeRange": { "CloseTime": number, "OpenTime": number }, "AnomalyResources": [ { "Name": "string", "Type": "string" } ], "AnomalyTimeRange": { "EndTime": number, "StartTime": number }, "AssociatedInsightId": "string", "CausalAnomalyId": "string", "Description": "string", "Id": "string", "Name": "string", "ResourceCollection": { "CloudFormation": { "StackNames": [ "string" ] }, "Tags": [ { "AppBoundaryKey": "string", "TagValues": [ "string" ] } ] }, "Severity": "string", "SourceDetails": { "CloudWatchMetrics": [ { "Dimensions": [ { "Name": "string", "Value": "string" } ], "MetricDataSummary": { "StatusCode": "string", "TimestampMetricValuePairList": [ { "MetricValue": number, "Timestamp": number } ] }, "MetricName": "string", "Namespace": "string", "Period": number, "Stat": "string", "Unit": "string" } ], "PerformanceInsightsMetrics": [ { "MetricDisplayName": "string", "MetricQuery": { "Filter": { "string" : "string" }, "GroupBy": { "Dimensions": [ "string" ], "Group": "string", "Limit": number }, "Metric": "string" }, "ReferenceData": [ { "ComparisonValues": { "ReferenceMetric": { "MetricQuery": { "Filter": { "string" : "string" }, "GroupBy": { "Dimensions": [ "string" ], "Group": "string", "Limit": number }, "Metric": "string" } }, "ReferenceScalar": { "Value": number } }, "Name": "string" } ], "StatsAtAnomaly": [ { "Type": "string", "Value": number } ], "StatsAtBaseline": [ { "Type": "string", "Value": number } ], "Unit": "string" } ] }, "Status": "string", "Type": "string" } }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

ProactiveAnomaly

A ProactiveAnomaly object that represents the requested anomaly.

Type: ProactiveAnomaly object

ReactiveAnomaly

A ReactiveAnomaly object that represents the requested anomaly.

Type: ReactiveAnomaly object

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You don't have permissions to perform the requested operation. The user or role that is making the request must have at least one IAM permissions policy attached that grants the required permissions. For more information, see Access Management in the IAM User Guide.

HTTP Status Code: 403

InternalServerException

An internal failure in an Amazon service occurred.

HTTP Status Code: 500

ResourceNotFoundException

A requested resource could not be found

HTTP Status Code: 404

ThrottlingException

The request was denied due to a request throttling.

HTTP Status Code: 429

ValidationException

Contains information about data passed in to a field during a request that is not valid.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: