Returns a list of measures that are potential causes or effects of an anomaly group.
Request Syntax
POST /ListAnomalyGroupRelatedMetrics HTTP/1.1
Content-type: application/json
{
"AnomalyDetectorArn": "string",
"AnomalyGroupId": "string",
"MaxResults": number,
"NextToken": "string",
"RelationshipTypeFilter": "string"
}URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
- AnomalyDetectorArn
-
The Amazon Resource Name (ARN) of the anomaly detector.
Type: String
Length Constraints: Maximum length of 256.
Pattern:
arn:([a-z\d-]+):.*:.*:.*:.+Required: Yes
- AnomalyGroupId
-
The ID of the anomaly group.
Type: String
Length Constraints: Maximum length of 63.
Pattern:
[a-z0-9]{8}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{12}Required: Yes
- MaxResults
-
The maximum number of results to return.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No
- NextToken
-
Specify the pagination token that's returned by a previous request to retrieve the next page of results.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 3000.
Pattern:
.*\S.*Required: No
- RelationshipTypeFilter
-
Filter for potential causes (
CAUSE_OF_INPUT_ANOMALY_GROUP) or downstream effects (EFFECT_OF_INPUT_ANOMALY_GROUP) of the anomaly group.Type: String
Valid Values:
CAUSE_OF_INPUT_ANOMALY_GROUP | EFFECT_OF_INPUT_ANOMALY_GROUPRequired: No
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"InterMetricImpactList": [
{
"AnomalyGroupId": "string",
"ContributionPercentage": number,
"MetricName": "string",
"RelationshipType": "string"
}
],
"NextToken": "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.
- InterMetricImpactList
-
Aggregated details about the measures contributing to the anomaly group, and the measures potentially impacted by the anomaly group.
Type: Array of InterMetricImpactDetails objects
- NextToken
-
The pagination token that's included if more results are available.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 3000.
Pattern:
.*\S.*
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You do not have sufficient permissions to perform this action.
HTTP Status Code: 403
- InternalServerException
-
The request processing has failed because of an unknown error, exception, or failure.
HTTP Status Code: 500
- ResourceNotFoundException
-
The specified resource cannot be found. Check the ARN of the resource and try again.
HTTP Status Code: 400
- TooManyRequestsException
-
The request was denied due to too many requests being submitted at the same time.
HTTP Status Code: 429
- ValidationException
-
The input fails to satisfy the constraints specified by the AWS service. Check your input values and try again.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
