Amazon Lookout for Metrics
API Reference
API Version 2017-07-25
Amazon Lookout for Metrics: API Reference
Copyright © Amazon Web Services, Inc. and/or its affiliates. All rights reserved.
Amazon's trademarks and trade dress may not be used in connection with any product or service that is not Amazon's, in any manner that is likely to cause confusion among customers, or in any manner that disparages or discredits Amazon. All other trademarks not owned by Amazon are the property of their respective owners, who may or may not be affiliated with, connected to, or sponsored by Amazon.
Table of Contents
Welcome ... 1
Actions ... 2
ActivateAnomalyDetector ... 3
Request Syntax ... 3
URI Request Parameters ... 3
Request Body ... 3
Response Syntax ... 3
Response Elements ... 3
Errors ... 3
See Also ... 4
BackTestAnomalyDetector ... 5
Request Syntax ... 5
URI Request Parameters ... 5
Request Body ... 5
Response Syntax ... 5
Response Elements ... 5
Errors ... 5
See Also ... 6
CreateAlert ... 7
Request Syntax ... 7
URI Request Parameters ... 7
Request Body ... 7
Response Syntax ... 8
Response Elements ... 8
Errors ... 9
See Also ... 9
CreateAnomalyDetector ... 11
Request Syntax ... 11
URI Request Parameters ... 11
Request Body ... 11
Response Syntax ... 12
Response Elements ... 12
Errors ... 12
See Also ... 13
CreateMetricSet ... 14
Request Syntax ... 14
URI Request Parameters ... 15
Request Body ... 15
Response Syntax ... 17
Response Elements ... 17
Errors ... 17
See Also ... 18
DeactivateAnomalyDetector ... 19
Request Syntax ... 19
URI Request Parameters ... 19
Request Body ... 19
Response Syntax ... 19
Response Elements ... 19
Errors ... 19
See Also ... 20
DeleteAlert ... 21
Request Syntax ... 21
URI Request Parameters ... 21
Request Body ... 21
Response Syntax ... 21
Response Elements ... 21
Errors ... 21
See Also ... 22
DeleteAnomalyDetector ... 23
Request Syntax ... 23
URI Request Parameters ... 23
Request Body ... 23
Response Syntax ... 23
Response Elements ... 23
Errors ... 23
See Also ... 24
DescribeAlert ... 25
Request Syntax ... 25
URI Request Parameters ... 25
Request Body ... 25
Response Syntax ... 25
Response Elements ... 26
Errors ... 26
See Also ... 26
DescribeAnomalyDetectionExecutions ... 28
Request Syntax ... 28
URI Request Parameters ... 28
Request Body ... 28
Response Syntax ... 29
Response Elements ... 29
Errors ... 29
See Also ... 30
DescribeAnomalyDetector ... 31
Request Syntax ... 31
URI Request Parameters ... 31
Request Body ... 31
Response Syntax ... 31
Response Elements ... 32
Errors ... 33
See Also ... 34
DescribeMetricSet ... 35
Request Syntax ... 35
URI Request Parameters ... 35
Request Body ... 35
Response Syntax ... 35
Response Elements ... 37
Errors ... 38
See Also ... 39
GetAnomalyGroup ... 40
Request Syntax ... 40
URI Request Parameters ... 40
Request Body ... 40
Response Syntax ... 40
Response Elements ... 41
Errors ... 41
See Also ... 42
GetFeedback ... 43
Request Syntax ... 43
URI Request Parameters ... 43
Request Body ... 43
Response Syntax ... 44
Response Elements ... 44
Errors ... 44
See Also ... 45
GetSampleData ... 46
Request Syntax ... 46
URI Request Parameters ... 46
Request Body ... 46
Response Syntax ... 46
Response Elements ... 47
Errors ... 47
See Also ... 47
ListAlerts ... 49
Request Syntax ... 49
URI Request Parameters ... 49
Request Body ... 49
Response Syntax ... 50
Response Elements ... 50
Errors ... 50
See Also ... 51
ListAnomalyDetectors ... 52
Request Syntax ... 52
URI Request Parameters ... 52
Request Body ... 52
Response Syntax ... 52
Response Elements ... 53
Errors ... 53
See Also ... 54
ListAnomalyGroupRelatedMetrics ... 55
Request Syntax ... 55
URI Request Parameters ... 55
Request Body ... 55
Response Syntax ... 56
Response Elements ... 56
Errors ... 57
See Also ... 57
ListAnomalyGroupSummaries ... 58
Request Syntax ... 58
URI Request Parameters ... 58
Request Body ... 58
Response Syntax ... 59
Response Elements ... 59
Errors ... 60
See Also ... 60
ListAnomalyGroupTimeSeries ... 61
Request Syntax ... 61
URI Request Parameters ... 61
Request Body ... 61
Response Syntax ... 62
Response Elements ... 62
Errors ... 63
See Also ... 64
ListMetricSets ... 65
Request Syntax ... 65
URI Request Parameters ... 65
Request Body ... 65
Response Syntax ... 66
Response Elements ... 66
Errors ... 66
See Also ... 67
ListTagsForResource ... 68
Request Syntax ... 68
URI Request Parameters ... 68
Request Body ... 68
Response Syntax ... 68
Response Elements ... 68
Errors ... 69
See Also ... 69
PutFeedback ... 70
Request Syntax ... 70
URI Request Parameters ... 70
Request Body ... 70
Response Syntax ... 70
Response Elements ... 70
Errors ... 71
See Also ... 71
TagResource ... 72
Request Syntax ... 72
URI Request Parameters ... 72
Request Body ... 72
Response Syntax ... 72
Response Elements ... 73
Errors ... 73
See Also ... 73
UntagResource ... 74
Request Syntax ... 74
URI Request Parameters ... 74
Request Body ... 74
Response Syntax ... 74
Response Elements ... 74
Errors ... 74
See Also ... 75
UpdateAnomalyDetector ... 76
Request Syntax ... 76
URI Request Parameters ... 76
Request Body ... 76
Response Syntax ... 77
Response Elements ... 77
Errors ... 77
See Also ... 78
UpdateMetricSet ... 79
Request Syntax ... 79
URI Request Parameters ... 80
Request Body ... 80
Response Syntax ... 81
Response Elements ... 81
Errors ... 82
See Also ... 82
Data Types ... 84
Action ... 86
Contents ... 86
See Also ... 86
Alert ... 87
Contents ... 87
See Also ... 88
AlertSummary ... 89
Contents ... 89
See Also ... 90
AnomalyDetectorConfig ... 91
Contents ... 91
See Also ... 91
AnomalyDetectorConfigSummary ... 92
Contents ... 92
See Also ... 92
AnomalyDetectorSummary ... 93
Contents ... 93
See Also ... 94
AnomalyGroup ... 95
Contents ... 95
See Also ... 96
AnomalyGroupStatistics ... 97
Contents ... 97
See Also ... 97
AnomalyGroupSummary ... 98
Contents ... 98
See Also ... 99
AnomalyGroupTimeSeries ... 100
Contents ... 100
See Also ... 100
AnomalyGroupTimeSeriesFeedback ... 101
Contents ... 101
See Also ... 101
AppFlowConfig ... 102
Contents ... 102
See Also ... 102
CloudWatchConfig ... 103
Contents ... 103
See Also ... 103
ContributionMatrix ... 104
Contents ... 104
See Also ... 104
CsvFormatDescriptor ... 105
Contents ... 105
See Also ... 106
DimensionContribution ... 107
Contents ... 107
See Also ... 107
DimensionNameValue ... 108
Contents ... 108
See Also ... 108
DimensionValueContribution ... 109
Contents ... 109
See Also ... 109
ExecutionStatus ... 110
Contents ... 110
See Also ... 110
FileFormatDescriptor ... 111
Contents ... 111
See Also ... 111
InterMetricImpactDetails ... 112
Contents ... 112
See Also ... 112
ItemizedMetricStats ... 114
Contents ... 114
See Also ... 114
JsonFormatDescriptor ... 115
Contents ... 115
See Also ... 115
LambdaConfiguration ... 116
Contents ... 116
See Also ... 116
Metric ... 117
Contents ... 117
See Also ... 117
MetricLevelImpact ... 118
Contents ... 118
See Also ... 118
MetricSetSummary ... 119
Contents ... 119
See Also ... 120
MetricSource ... 121
Contents ... 121
See Also ... 121
RDSSourceConfig ... 122
Contents ... 122
See Also ... 123
RedshiftSourceConfig ... 124
Contents ... 124
See Also ... 125
S3SourceConfig ... 126
Contents ... 126
See Also ... 126
SampleDataS3SourceConfig ... 128
Contents ... 128
See Also ... 128
SNSConfiguration ... 130
Contents ... 130
See Also ... 130
TimeSeries ... 131
Contents ... 131
See Also ... 131
TimeSeriesFeedback ... 132
Contents ... 132
See Also ... 132
TimestampColumn ... 133
Contents ... 133
See Also ... 133
ValidationExceptionField ... 134
Contents ... 134
See Also ... 134
VpcConfiguration ... 135
Contents ... 135
See Also ... 135
Common Parameters ... 136
Common Errors ... 138
Welcome
This is the Amazon Lookout for Metrics API Reference. For an introduction to the service with tutorials for getting started, visit Amazon Lookout for Metrics Developer Guide.
This document was last published on March 6, 2022.
Actions
The following actions are supported:
• ActivateAnomalyDetector (p. 3)
• BackTestAnomalyDetector (p. 5)
• CreateAlert (p. 7)
• CreateAnomalyDetector (p. 11)
• CreateMetricSet (p. 14)
• DeactivateAnomalyDetector (p. 19)
• DeleteAlert (p. 21)
• DeleteAnomalyDetector (p. 23)
• DescribeAlert (p. 25)
• DescribeAnomalyDetectionExecutions (p. 28)
• DescribeAnomalyDetector (p. 31)
• DescribeMetricSet (p. 35)
• GetAnomalyGroup (p. 40)
• GetFeedback (p. 43)
• GetSampleData (p. 46)
• ListAlerts (p. 49)
• ListAnomalyDetectors (p. 52)
• ListAnomalyGroupRelatedMetrics (p. 55)
• ListAnomalyGroupSummaries (p. 58)
• ListAnomalyGroupTimeSeries (p. 61)
• ListMetricSets (p. 65)
• ListTagsForResource (p. 68)
• PutFeedback (p. 70)
• TagResource (p. 72)
• UntagResource (p. 74)
• UpdateAnomalyDetector (p. 76)
• UpdateMetricSet (p. 79)
ActivateAnomalyDetector
ActivateAnomalyDetector
Activates an anomaly detector.
Request Syntax
POST /ActivateAnomalyDetector HTTP/1.1 Content-type: application/json
{ "AnomalyDetectorArn": "string"
}
URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
AnomalyDetectorArn (p. 3)
The ARN of the anomaly detector.
Type: String
Length Constraints: Maximum length of 256.
Pattern: arn:([a-z\d-]+):.*:.*:.*:.+
Required: Yes
Response Syntax
HTTP/1.1 200
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
Errors
For information about the errors that are common to all actions, see Common Errors (p. 138).
AccessDeniedException
You do not have sufficient permissions to perform this action.
HTTP Status Code: 403 ConflictException
There was a conflict processing the request. Try your request again.
See Also
HTTP Status Code: 409 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:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
BackTestAnomalyDetector
BackTestAnomalyDetector
Runs a backtest for anomaly detection for the specified resource.
Request Syntax
POST /BackTestAnomalyDetector HTTP/1.1 Content-type: application/json
{ "AnomalyDetectorArn": "string"
}
URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
AnomalyDetectorArn (p. 5)
The Amazon Resource Name (ARN) of the anomaly detector.
Type: String
Length Constraints: Maximum length of 256.
Pattern: arn:([a-z\d-]+):.*:.*:.*:.+
Required: Yes
Response Syntax
HTTP/1.1 200
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
Errors
For information about the errors that are common to all actions, see Common Errors (p. 138).
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.
See Also
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:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
CreateAlert
CreateAlert
Creates an alert for an anomaly detector.
Request Syntax
POST /CreateAlert HTTP/1.1 Content-type: application/json { "Action": {
"LambdaConfiguration": { "LambdaArn": "string", "RoleArn": "string"
},
"SNSConfiguration": { "RoleArn": "string", "SnsTopicArn": "string"
} },
"AlertDescription": "string", "AlertName": "string",
"AlertSensitivityThreshold": number, "AnomalyDetectorArn": "string", "Tags": {
"string" : "string"
} }
URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
Action (p. 7)
Action that will be triggered when there is an alert.
Type: Action (p. 86) object Required: Yes
AlertDescription (p. 7) A description of the alert.
Type: String
Length Constraints: Maximum length of 256.
Pattern: .*\S.*
Required: No AlertName (p. 7)
The name of the alert.
Response Syntax
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-_]*
Required: Yes
AlertSensitivityThreshold (p. 7)
An integer from 0 to 100 specifying the alert sensitivity threshold.
Type: Integer
Valid Range: Minimum value of 0. Maximum value of 100.
Required: Yes
AnomalyDetectorArn (p. 7)
The ARN of the detector to which the alert is attached.
Type: String
Length Constraints: Maximum length of 256.
Pattern: arn:([a-z\d-]+):.*:.*:.*:.+
Required: Yes Tags (p. 7)
A list of tags to apply to the alert.
Type: String to string map
Map Entries: Maximum number of 50 items.
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Value Length Constraints: Maximum length of 256.
Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json { "AlertArn": "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.
AlertArn (p. 8)
The ARN of the alert.
Errors
Type: String
Length Constraints: Maximum length of 256.
Pattern: arn:([a-z\d-]+):.*:.*:.*:.+
Errors
For information about the errors that are common to all actions, see Common Errors (p. 138).
AccessDeniedException
You do not have sufficient permissions to perform this action.
HTTP Status Code: 403 ConflictException
There was a conflict processing the request. Try your request again.
HTTP Status Code: 409 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 ServiceQuotaExceededException
The request exceeded the service's quotas. Check the service quotas and try again.
HTTP Status Code: 402 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:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
See Also
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
CreateAnomalyDetector
CreateAnomalyDetector
Creates an anomaly detector.
Request Syntax
POST /CreateAnomalyDetector HTTP/1.1 Content-type: application/json {
"AnomalyDetectorConfig": {
"AnomalyDetectorFrequency": "string"
},
"AnomalyDetectorDescription": "string", "AnomalyDetectorName": "string",
"KmsKeyArn": "string", "Tags": {
"string" : "string"
}}
URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
AnomalyDetectorConfig (p. 11)
Contains information about the configuration of the anomaly detector.
Type: AnomalyDetectorConfig (p. 91) object Required: Yes
AnomalyDetectorDescription (p. 11) A description of the detector.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: .*\S.*
Required: No
AnomalyDetectorName (p. 11) The name of the detector.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-_]*
Response Syntax
Required: Yes KmsKeyArn (p. 11)
The ARN of the KMS key to use to encrypt your data.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
Pattern: arn:aws.*:kms:.*:[0-9]{12}:key/[a-z0-9]{8}-[a-z0-9]{4}-[a-z0-9]{4}- [a-z0-9]{4}-[a-z0-9]{12}
Required: No Tags (p. 11)
A list of tags to apply to the anomaly detector.
Type: String to string map
Map Entries: Maximum number of 50 items.
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Value Length Constraints: Maximum length of 256.
Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json { "AnomalyDetectorArn": "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.
AnomalyDetectorArn (p. 12) The ARN of the detector.
Type: String
Length Constraints: Maximum length of 256.
Pattern: arn:([a-z\d-]+):.*:.*:.*:.+
Errors
For information about the errors that are common to all actions, see Common Errors (p. 138).
See Also
AccessDeniedException
You do not have sufficient permissions to perform this action.
HTTP Status Code: 403 ConflictException
There was a conflict processing the request. Try your request again.
HTTP Status Code: 409 ConflictException
There was a conflict processing the request. Try your request again.
HTTP Status Code: 409 InternalServerException
The request processing has failed because of an unknown error, exception, or failure.
HTTP Status Code: 500 ServiceQuotaExceededException
The request exceeded the service's quotas. Check the service quotas and try again.
HTTP Status Code: 402 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:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
CreateMetricSet
CreateMetricSet
Creates a dataset.
Request Syntax
POST /CreateMetricSet HTTP/1.1 Content-type: application/json { "AnomalyDetectorArn": "string", "DimensionList": [ "string" ], "MetricList": [
{
"AggregationFunction": "string", "MetricName": "string",
"Namespace": "string"
} ],
"MetricSetDescription": "string", "MetricSetFrequency": "string", "MetricSetName": "string", "MetricSource": {
"AppFlowConfig": { "FlowName": "string", "RoleArn": "string"
},
"CloudWatchConfig": { "RoleArn": "string"
},
"RDSSourceConfig": { "DatabaseHost": "string", "DatabaseName": "string", "DatabasePort": number,
"DBInstanceIdentifier": "string", "RoleArn": "string",
"SecretManagerArn": "string", "TableName": "string",
"VpcConfiguration": {
"SecurityGroupIdList": [ "string" ], "SubnetIdList": [ "string" ]
} },
"RedshiftSourceConfig": { "ClusterIdentifier": "string", "DatabaseHost": "string", "DatabaseName": "string", "DatabasePort": number, "RoleArn": "string",
"SecretManagerArn": "string", "TableName": "string",
"VpcConfiguration": {
"SecurityGroupIdList": [ "string" ], "SubnetIdList": [ "string" ]
} },
"S3SourceConfig": {
"FileFormatDescriptor": { "CsvFormatDescriptor": { "Charset": "string", "ContainsHeader": boolean, "Delimiter": "string", "FileCompression": "string",
URI Request Parameters
"HeaderList": [ "string" ], "QuoteSymbol": "string"
},
"JsonFormatDescriptor": { "Charset": "string",
"FileCompression": "string"
} },
"HistoricalDataPathList": [ "string" ], "RoleArn": "string",
"TemplatedPathList": [ "string" ] }
},
"Offset": number, "Tags": {
"string" : "string"
},
"TimestampColumn": { "ColumnFormat": "string", "ColumnName": "string"
},
"Timezone": "string"
}
URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
AnomalyDetectorArn (p. 14)
The ARN of the anomaly detector that will use the dataset.
Type: String
Length Constraints: Maximum length of 256.
Pattern: arn:([a-z\d-]+):.*:.*:.*:.+
Required: Yes DimensionList (p. 14)
A list of the fields you want to treat as dimensions.
Type: Array of strings
Array Members: Minimum number of 1 item.
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-_]*
Required: No MetricList (p. 14)
A list of metrics that the dataset will contain.
Type: Array of Metric (p. 117) objects
Request Body
Array Members: Minimum number of 1 item.
Required: Yes
MetricSetDescription (p. 14)
A description of the dataset you are creating.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: .*\S.*
Required: No
MetricSetFrequency (p. 14)
The frequency with which the source data will be analyzed for anomalies.
Type: String
Valid Values: P1D | PT1H | PT10M | PT5M Required: No
MetricSetName (p. 14) The name of the dataset.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-_]*
Required: Yes MetricSource (p. 14)
Contains information about how the source data should be interpreted.
Type: MetricSource (p. 121) object Required: Yes
Offset (p. 14)
After an interval ends, the amount of seconds that the detector waits before importing data. Offset is only supported for S3 and Redshift datasources.
Type: Integer
Valid Range: Minimum value of 0. Maximum value of 432000.
Required: No Tags (p. 14)
A list of tags to apply to the dataset.
Type: String to string map
Map Entries: Maximum number of 50 items.
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Response Syntax
Value Length Constraints: Maximum length of 256.
Required: No
TimestampColumn (p. 14)
Contains information about the column used for tracking time in your source data.
Type: TimestampColumn (p. 133) object Required: No
Timezone (p. 14)
The time zone in which your source data was recorded.
Type: String
Length Constraints: Maximum length of 60.
Pattern: .*\S.*
Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json { "MetricSetArn": "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.
MetricSetArn (p. 17) The ARN of the dataset.
Type: String
Length Constraints: Maximum length of 256.
Pattern: arn:([a-z\d-]+):.*:.*:.*:.+
Errors
For information about the errors that are common to all actions, see Common Errors (p. 138).
AccessDeniedException
You do not have sufficient permissions to perform this action.
HTTP Status Code: 403
See Also
ConflictException
There was a conflict processing the request. Try your request again.
HTTP Status Code: 409 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 ServiceQuotaExceededException
The request exceeded the service's quotas. Check the service quotas and try again.
HTTP Status Code: 402 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:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
DeactivateAnomalyDetector
DeactivateAnomalyDetector
Deactivates an anomaly detector.
Request Syntax
POST /DeactivateAnomalyDetector HTTP/1.1 Content-type: application/json
{ "AnomalyDetectorArn": "string"
}
URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
AnomalyDetectorArn (p. 19)
The Amazon Resource Name (ARN) of the anomaly detector.
Type: String
Length Constraints: Maximum length of 256.
Pattern: arn:([a-z\d-]+):.*:.*:.*:.+
Required: Yes
Response Syntax
HTTP/1.1 200
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
Errors
For information about the errors that are common to all actions, see Common Errors (p. 138).
AccessDeniedException
You do not have sufficient permissions to perform this action.
HTTP Status Code: 403 ConflictException
There was a conflict processing the request. Try your request again.
See Also
HTTP Status Code: 409 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:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
DeleteAlert
DeleteAlert
Deletes an alert.
Request Syntax
POST /DeleteAlert HTTP/1.1 Content-type: application/json { "AlertArn": "string"
}
URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
AlertArn (p. 21)
The ARN of the alert to delete.
Type: String
Length Constraints: Maximum length of 256.
Pattern: arn:([a-z\d-]+):.*:.*:.*:.+
Required: Yes
Response Syntax
HTTP/1.1 200
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
Errors
For information about the errors that are common to all actions, see Common Errors (p. 138).
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.
See Also
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:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
DeleteAnomalyDetector
DeleteAnomalyDetector
Deletes a detector. Deleting an anomaly detector will delete all of its corresponding resources including any configured datasets and alerts.
Request Syntax
POST /DeleteAnomalyDetector HTTP/1.1 Content-type: application/json { "AnomalyDetectorArn": "string"
}
URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
AnomalyDetectorArn (p. 23)
The ARN of the detector to delete.
Type: String
Length Constraints: Maximum length of 256.
Pattern: arn:([a-z\d-]+):.*:.*:.*:.+
Required: Yes
Response Syntax
HTTP/1.1 200
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
Errors
For information about the errors that are common to all actions, see Common Errors (p. 138).
AccessDeniedException
You do not have sufficient permissions to perform this action.
HTTP Status Code: 403
See Also
ConflictException
There was a conflict processing the request. Try your request again.
HTTP Status Code: 409 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:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
DescribeAlert
DescribeAlert
Describes an alert.
Amazon Lookout for Metrics API actions are eventually consistent. If you do a read operation on a resource immediately after creating or modifying it, use retries to allow time for the write operation to complete.
Request Syntax
POST /DescribeAlert HTTP/1.1 Content-type: application/json { "AlertArn": "string"
}
URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
AlertArn (p. 25)
The ARN of the alert to describe.
Type: String
Length Constraints: Maximum length of 256.
Pattern: arn:([a-z\d-]+):.*:.*:.*:.+
Required: Yes
Response Syntax
HTTP/1.1 200
Content-type: application/json { "Alert": {
"Action": {
"LambdaConfiguration": { "LambdaArn": "string", "RoleArn": "string"
},
"SNSConfiguration": { "RoleArn": "string", "SnsTopicArn": "string"
} },
"AlertArn": "string",
"AlertDescription": "string",
Response Elements
"AlertName": "string",
"AlertSensitivityThreshold": number, "AlertStatus": "string",
"AlertType": "string",
"AnomalyDetectorArn": "string", "CreationTime": number,
"LastModificationTime": number }}
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.
Alert (p. 25)
Contains information about an alert.
Type: Alert (p. 87) object
Errors
For information about the errors that are common to all actions, see Common Errors (p. 138).
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:
See Also
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
DescribeAnomalyDetectionExecutions
DescribeAnomalyDetectionExecutions
Returns information about the status of the specified anomaly detection jobs.
Request Syntax
POST /DescribeAnomalyDetectionExecutions HTTP/1.1 Content-type: application/json
{ "AnomalyDetectorArn": "string", "MaxResults": number,
"NextToken": "string", "Timestamp": "string"
}
URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
AnomalyDetectorArn (p. 28)
The Amazon Resource Name (ARN) of the anomaly detector.
Type: String
Length Constraints: Maximum length of 256.
Pattern: arn:([a-z\d-]+):.*:.*:.*:.+
Required: Yes MaxResults (p. 28)
The number of items to return in the response.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No NextToken (p. 28)
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
Response Syntax
Timestamp (p. 28)
The timestamp of the anomaly detection job.
Type: String
Length Constraints: Maximum length of 60.
Pattern: ^([12]\d{3})-(1[0-2]|0[1-9])-(0[1-9]|[12]\d|3[01])T([01]\d|2[0-3]):
([0-5]\d):([0-5]\d)(Z|(\+|\-)(0\d|1[0-2]):([0-5]\d)(\[[[:alnum:]\/\_]+\])?)$
Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json {
"ExecutionList": [ {
"FailureReason": "string", "Status": "string", "Timestamp": "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.
ExecutionList (p. 29) A list of detection jobs.
Type: Array of ExecutionStatus (p. 110) objects NextToken (p. 29)
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 (p. 138).
AccessDeniedException
You do not have sufficient permissions to perform this action.
See Also
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:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
DescribeAnomalyDetector
DescribeAnomalyDetector
Describes a detector.
Amazon Lookout for Metrics API actions are eventually consistent. If you do a read operation on a resource immediately after creating or modifying it, use retries to allow time for the write operation to complete.
Request Syntax
POST /DescribeAnomalyDetector HTTP/1.1 Content-type: application/json
{ "AnomalyDetectorArn": "string"
}
URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
AnomalyDetectorArn (p. 31)
The ARN of the detector to describe.
Type: String
Length Constraints: Maximum length of 256.
Pattern: arn:([a-z\d-]+):.*:.*:.*:.+
Required: Yes
Response Syntax
HTTP/1.1 200
Content-type: application/json {
"AnomalyDetectorArn": "string", "AnomalyDetectorConfig": {
"AnomalyDetectorFrequency": "string"
},
"AnomalyDetectorDescription": "string", "AnomalyDetectorName": "string",
"CreationTime": number, "FailureReason": "string", "FailureType": "string", "KmsKeyArn": "string",
"LastModificationTime": number, "Status": "string"
Response Elements
}
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.
AnomalyDetectorArn (p. 31) The ARN of the detector.
Type: String
Length Constraints: Maximum length of 256.
Pattern: arn:([a-z\d-]+):.*:.*:.*:.+
AnomalyDetectorConfig (p. 31)
Contains information about the detector's configuration.
Type: AnomalyDetectorConfigSummary (p. 92) object AnomalyDetectorDescription (p. 31)
A description of the detector.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: .*\S.*
AnomalyDetectorName (p. 31) The name of the detector.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-_]*
CreationTime (p. 31)
The time at which the detector was created.
Type: Timestamp FailureReason (p. 31)
The reason that the detector failed.
Type: String
Length Constraints: Maximum length of 256.
FailureType (p. 31)
The process that caused the detector to fail.
Type: String
Errors
Valid Values: ACTIVATION_FAILURE | BACK_TEST_ACTIVATION_FAILURE | DELETION_FAILURE | DEACTIVATION_FAILURE
KmsKeyArn (p. 31)
The ARN of the KMS key to use to encrypt your data.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
Pattern: arn:aws.*:kms:.*:[0-9]{12}:key/[a-z0-9]{8}-[a-z0-9]{4}-[a-z0-9]{4}- [a-z0-9]{4}-[a-z0-9]{12}
LastModificationTime (p. 31)
The time at which the detector was last modified.
Type: Timestamp Status (p. 31)
The status of the detector.
Type: String
Valid Values: ACTIVE | ACTIVATING | DELETING | FAILED | INACTIVE | LEARNING | BACK_TEST_ACTIVATING | BACK_TEST_ACTIVE | BACK_TEST_COMPLETE | DEACTIVATED | DEACTIVATING
Errors
For information about the errors that are common to all actions, see Common Errors (p. 138).
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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
DescribeMetricSet
DescribeMetricSet
Describes a dataset.
Amazon Lookout for Metrics API actions are eventually consistent. If you do a read operation on a resource immediately after creating or modifying it, use retries to allow time for the write operation to complete.
Request Syntax
POST /DescribeMetricSet HTTP/1.1 Content-type: application/json { "MetricSetArn": "string"
}
URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
MetricSetArn (p. 35) The ARN of the dataset.
Type: String
Length Constraints: Maximum length of 256.
Pattern: arn:([a-z\d-]+):.*:.*:.*:.+
Required: Yes
Response Syntax
HTTP/1.1 200
Content-type: application/json {
"AnomalyDetectorArn": "string", "CreationTime": number,
"DimensionList": [ "string" ], "LastModificationTime": number, "MetricList": [
{
"AggregationFunction": "string", "MetricName": "string",
"Namespace": "string"
} ],
"MetricSetArn": "string",
"MetricSetDescription": "string", "MetricSetFrequency": "string", "MetricSetName": "string",
Response Syntax
"MetricSource": { "AppFlowConfig": { "FlowName": "string", "RoleArn": "string"
},
"CloudWatchConfig": { "RoleArn": "string"
},
"RDSSourceConfig": { "DatabaseHost": "string", "DatabaseName": "string", "DatabasePort": number,
"DBInstanceIdentifier": "string", "RoleArn": "string",
"SecretManagerArn": "string", "TableName": "string", "VpcConfiguration": {
"SecurityGroupIdList": [ "string" ], "SubnetIdList": [ "string" ]
} },
"RedshiftSourceConfig": { "ClusterIdentifier": "string", "DatabaseHost": "string", "DatabaseName": "string", "DatabasePort": number, "RoleArn": "string",
"SecretManagerArn": "string", "TableName": "string", "VpcConfiguration": {
"SecurityGroupIdList": [ "string" ], "SubnetIdList": [ "string" ]
} },
"S3SourceConfig": {
"FileFormatDescriptor": { "CsvFormatDescriptor": { "Charset": "string", "ContainsHeader": boolean, "Delimiter": "string", "FileCompression": "string", "HeaderList": [ "string" ], "QuoteSymbol": "string"
},
"JsonFormatDescriptor": { "Charset": "string",
"FileCompression": "string"
} },
"HistoricalDataPathList": [ "string" ], "RoleArn": "string",
"TemplatedPathList": [ "string" ] }
},
"Offset": number, "TimestampColumn": { "ColumnFormat": "string", "ColumnName": "string"
},
"Timezone": "string"
}
Response Elements
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.
AnomalyDetectorArn (p. 35)
The ARN of the detector that contains the dataset.
Type: String
Length Constraints: Maximum length of 256.
Pattern: arn:([a-z\d-]+):.*:.*:.*:.+
CreationTime (p. 35)
The time at which the dataset was created.
Type: Timestamp DimensionList (p. 35)
A list of the dimensions chosen for analysis.
Type: Array of strings
Array Members: Minimum number of 1 item.
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-_]*
LastModificationTime (p. 35)
The time at which the dataset was last modified.
Type: Timestamp MetricList (p. 35)
A list of the metrics defined by the dataset.
Type: Array of Metric (p. 117) objects Array Members: Minimum number of 1 item.
MetricSetArn (p. 35) The ARN of the dataset.
Type: String
Length Constraints: Maximum length of 256.
Pattern: arn:([a-z\d-]+):.*:.*:.*:.+
MetricSetDescription (p. 35) The dataset's description.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Errors
Pattern: .*\S.*
MetricSetFrequency (p. 35)
The interval at which the data will be analyzed for anomalies.
Type: String
Valid Values: P1D | PT1H | PT10M | PT5M MetricSetName (p. 35)
The name of the dataset.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-_]*
MetricSource (p. 35)
Contains information about the dataset's source data.
Type: MetricSource (p. 121) object Offset (p. 35)
The offset in seconds. Only supported for S3 and Redshift datasources.
Type: Integer
Valid Range: Minimum value of 0. Maximum value of 432000.
TimestampColumn (p. 35)
Contains information about the column used for tracking time in your source data.
Type: TimestampColumn (p. 133) object Timezone (p. 35)
The time zone in which the dataset's data was recorded.
Type: String
Length Constraints: Maximum length of 60.
Pattern: .*\S.*
Errors
For information about the errors that are common to all actions, see Common Errors (p. 138).
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
See Also
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:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
GetAnomalyGroup
GetAnomalyGroup
Returns details about a group of anomalous metrics.
Request Syntax
POST /GetAnomalyGroup HTTP/1.1 Content-type: application/json { "AnomalyDetectorArn": "string", "AnomalyGroupId": "string"
}
URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
AnomalyDetectorArn (p. 40)
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 (p. 40)
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
Response Syntax
HTTP/1.1 200
Content-type: application/json { "AnomalyGroup": {
"AnomalyGroupId": "string", "AnomalyGroupScore": number,
Response Elements
"EndTime": "string", "MetricLevelImpactList": [ {
"ContributionMatrix": {
"DimensionContributionList": [ {
"DimensionName": "string",
"DimensionValueContributionList": [ {
"ContributionScore": number, "DimensionValue": "string"
} ] } ] },
"MetricName": "string", "NumTimeSeries": number }
],
"PrimaryMetricName": "string", "StartTime": "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.
AnomalyGroup (p. 40)
Details about the anomaly group.
Type: AnomalyGroup (p. 95) object
Errors
For information about the errors that are common to all actions, see Common Errors (p. 138).
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.
See Also
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:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
GetFeedback
GetFeedback
Get feedback for an anomaly group.
Request Syntax
POST /GetFeedback HTTP/1.1 Content-type: application/json { "AnomalyDetectorArn": "string", "AnomalyGroupTimeSeriesFeedback": { "AnomalyGroupId": "string", "TimeSeriesId": "string"
},
"MaxResults": number, "NextToken": "string"
}
URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
AnomalyDetectorArn (p. 43)
The Amazon Resource Name (ARN) of the anomaly detector.
Type: String
Length Constraints: Maximum length of 256.
Pattern: arn:([a-z\d-]+):.*:.*:.*:.+
Required: Yes
AnomalyGroupTimeSeriesFeedback (p. 43) The anomalous metric and group ID.
Type: AnomalyGroupTimeSeries (p. 100) object Required: Yes
MaxResults (p. 43)
The maximum number of results to return.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No NextToken (p. 43)
Specify the pagination token that's returned by a previous request to retrieve the next page of results.
Response Syntax
Type: String
Length Constraints: Minimum length of 1. Maximum length of 3000.
Pattern: .*\S.*
Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json
{ "AnomalyGroupTimeSeriesFeedback": [ {
"IsAnomaly": boolean, "TimeSeriesId": "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.
AnomalyGroupTimeSeriesFeedback (p. 44) Feedback for an anomalous metric.
Type: Array of TimeSeriesFeedback (p. 132) objects NextToken (p. 44)
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 (p. 138).
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.
See Also
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:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
GetSampleData
GetSampleData
Returns a selection of sample records from an Amazon S3 datasource.
Request Syntax
POST /GetSampleData HTTP/1.1 Content-type: application/json { "S3SourceConfig": {
"FileFormatDescriptor": { "CsvFormatDescriptor": { "Charset": "string", "ContainsHeader": boolean, "Delimiter": "string", "FileCompression": "string", "HeaderList": [ "string" ], "QuoteSymbol": "string"
},
"JsonFormatDescriptor": { "Charset": "string", "FileCompression": "string"
} },
"HistoricalDataPathList": [ "string" ], "RoleArn": "string",
"TemplatedPathList": [ "string" ] }}
URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
S3SourceConfig (p. 46)
A datasource bucket in Amazon S3.
Type: SampleDataS3SourceConfig (p. 128) object Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json { "HeaderValues": [ "string" ], "SampleRows": [
[ "string" ]
Response Elements
] }
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.
HeaderValues (p. 46)
A list of header labels for the records.
Type: Array of strings SampleRows (p. 46)
A list of records.
Type: Array of arrays of strings
Errors
For information about the errors that are common to all actions, see Common Errors (p. 138).
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:
• AWS Command Line Interface
See Also
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
ListAlerts
ListAlerts
Lists the alerts attached to a detector.
Amazon Lookout for Metrics API actions are eventually consistent. If you do a read operation on a resource immediately after creating or modifying it, use retries to allow time for the write operation to complete.
Request Syntax
POST /ListAlerts HTTP/1.1 Content-type: application/json { "AnomalyDetectorArn": "string", "MaxResults": number,
"NextToken": "string"
}
URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
AnomalyDetectorArn (p. 49) The ARN of the alert's detector.
Type: String
Length Constraints: Maximum length of 256.
Pattern: arn:([a-z\d-]+):.*:.*:.*:.+
Required: No MaxResults (p. 49)
The maximum number of results that will be displayed by the request.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No NextToken (p. 49)
If the result of the previous request is truncated, the response includes a NextToken. To retrieve the next set of results, use the token in the next request. Tokens expire after 24 hours.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 3000.
Pattern: .*\S.*
