{"note":"OpenAPI conversion -- returning structured metadata","name":"amazonaws-com-lookoutmetrics","description":"Amazon Lookout for Metrics","version":"2017-07-25","base_url":"","endpoints":30,"raw":"@lap v0.3\n# Machine-readable API spec. Each @endpoint block is one API call.\n@api Amazon Lookout for Metrics\n@version 2017-07-25\n@auth AWS SigV4\n@endpoints 30\n@hint download_for_search\n@toc ActivateAnomalyDetector(1), BackTestAnomalyDetector(1), CreateAlert(1), CreateAnomalyDetector(1), CreateMetricSet(1), DeactivateAnomalyDetector(1), DeleteAlert(1), DeleteAnomalyDetector(1), DescribeAlert(1), DescribeAnomalyDetectionExecutions(1), DescribeAnomalyDetector(1), DescribeMetricSet(1), DetectMetricSetConfig(1), GetAnomalyGroup(1), GetDataQualityMetrics(1), GetFeedback(1), GetSampleData(1), ListAlerts(1), ListAnomalyDetectors(1), ListAnomalyGroupRelatedMetrics(1), ListAnomalyGroupSummaries(1), ListAnomalyGroupTimeSeries(1), ListMetricSets(1), tags(3), PutFeedback(1), UpdateAlert(1), UpdateAnomalyDetector(1), UpdateMetricSet(1)\n\n@group ActivateAnomalyDetector\n@endpoint POST /ActivateAnomalyDetector\n@desc Activates an anomaly detector.\n@required {AnomalyDetectorArn: str}\n\n@endgroup\n\n@group BackTestAnomalyDetector\n@endpoint POST /BackTestAnomalyDetector\n@desc Runs a backtest for anomaly detection for the specified resource.\n@required {AnomalyDetectorArn: str}\n\n@endgroup\n\n@group CreateAlert\n@endpoint POST /CreateAlert\n@desc Creates an alert for an anomaly detector.\n@required {AlertName: str, AnomalyDetectorArn: str, Action: Action}\n@optional {AlertSensitivityThreshold: int, AlertDescription: str, Tags: map<str,str>, AlertFilters: AlertFilters}\n@returns(200) {AlertArn: str?}\n\n@endgroup\n\n@group CreateAnomalyDetector\n@endpoint POST /CreateAnomalyDetector\n@desc Creates an anomaly detector.\n@required {AnomalyDetectorName: str, AnomalyDetectorConfig: AnomalyDetectorConfig}\n@optional {AnomalyDetectorDescription: str, KmsKeyArn: str, Tags: map<str,str>}\n@returns(200) {AnomalyDetectorArn: str?}\n\n@endgroup\n\n@group CreateMetricSet\n@endpoint POST /CreateMetricSet\n@desc Creates a dataset.\n@required {AnomalyDetectorArn: str, MetricSetName: str, MetricList: [Metric], MetricSource: MetricSource}\n@optional {MetricSetDescription: str, Offset: int, TimestampColumn: TimestampColumn, DimensionList: [str], MetricSetFrequency: str, Timezone: str, Tags: map<str,str>, DimensionFilterList: [MetricSetDimensionFilter]}\n@returns(200) {MetricSetArn: str?}\n\n@endgroup\n\n@group DeactivateAnomalyDetector\n@endpoint POST /DeactivateAnomalyDetector\n@desc Deactivates an anomaly detector.\n@required {AnomalyDetectorArn: str}\n\n@endgroup\n\n@group DeleteAlert\n@endpoint POST /DeleteAlert\n@desc Deletes an alert.\n@required {AlertArn: str}\n\n@endgroup\n\n@group DeleteAnomalyDetector\n@endpoint POST /DeleteAnomalyDetector\n@desc Deletes a detector. Deleting an anomaly detector will delete all of its corresponding resources including any configured datasets and alerts.\n@required {AnomalyDetectorArn: str}\n\n@endgroup\n\n@group DescribeAlert\n@endpoint POST /DescribeAlert\n@desc 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.\n@required {AlertArn: str}\n@returns(200) {Alert: Alert?{Action: Action?{SNSConfiguration: SNSConfiguration?{RoleArn: str, SnsTopicArn: str, SnsFormat: str?}, LambdaConfiguration: LambdaConfiguration?{RoleArn: str, LambdaArn: str}}, AlertDescription: str?, AlertArn: str?, AnomalyDetectorArn: str?, AlertName: str?, AlertSensitivityThreshold: int?, AlertType: str?, AlertStatus: str?, LastModificationTime: str(timestamp)?, CreationTime: str(timestamp)?, AlertFilters: AlertFilters?{MetricList: [str]?, DimensionFilterList: [DimensionFilter]?}}}\n\n@endgroup\n\n@group DescribeAnomalyDetectionExecutions\n@endpoint POST /DescribeAnomalyDetectionExecutions\n@desc Returns information about the status of the specified anomaly detection jobs.\n@required {AnomalyDetectorArn: str}\n@optional {Timestamp: str, MaxResults: int, NextToken: str}\n@returns(200) {ExecutionList: [ExecutionStatus]?, NextToken: str?}\n\n@endgroup\n\n@group DescribeAnomalyDetector\n@endpoint POST /DescribeAnomalyDetector\n@desc 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.\n@required {AnomalyDetectorArn: str}\n@returns(200) {AnomalyDetectorArn: str?, AnomalyDetectorName: str?, AnomalyDetectorDescription: str?, AnomalyDetectorConfig: AnomalyDetectorConfigSummary?{AnomalyDetectorFrequency: str?}, CreationTime: str(timestamp)?, LastModificationTime: str(timestamp)?, Status: str?, FailureReason: str?, KmsKeyArn: str?, FailureType: str?}\n\n@endgroup\n\n@group DescribeMetricSet\n@endpoint POST /DescribeMetricSet\n@desc 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.\n@required {MetricSetArn: str}\n@returns(200) {MetricSetArn: str?, AnomalyDetectorArn: str?, MetricSetName: str?, MetricSetDescription: str?, CreationTime: str(timestamp)?, LastModificationTime: str(timestamp)?, Offset: int?, MetricList: [Metric]?, TimestampColumn: TimestampColumn?{ColumnName: str?, ColumnFormat: str?}, DimensionList: [str]?, MetricSetFrequency: str?, Timezone: str?, MetricSource: MetricSource?{S3SourceConfig: S3SourceConfig?{RoleArn: str?, TemplatedPathList: [str]?, HistoricalDataPathList: [str]?, FileFormatDescriptor: FileFormatDescriptor?{CsvFormatDescriptor: CsvFormatDescriptor?, JsonFormatDescriptor: JsonFormatDescriptor?}}, AppFlowConfig: AppFlowConfig?{RoleArn: str?, FlowName: str?}, CloudWatchConfig: CloudWatchConfig?{RoleArn: str?, BackTestConfiguration: BackTestConfiguration?{RunBackTestMode: bool}}, RDSSourceConfig: RDSSourceConfig?{DBInstanceIdentifier: str?, DatabaseHost: str?, DatabasePort: int?, SecretManagerArn: str?, DatabaseName: str?, TableName: str?, RoleArn: str?, VpcConfiguration: VpcConfiguration?{SubnetIdList: [str], SecurityGroupIdList: [str]}}, RedshiftSourceConfig: RedshiftSourceConfig?{ClusterIdentifier: str?, DatabaseHost: str?, DatabasePort: int?, SecretManagerArn: str?, DatabaseName: str?, TableName: str?, RoleArn: str?, VpcConfiguration: VpcConfiguration?{SubnetIdList: [str], SecurityGroupIdList: [str]}}, AthenaSourceConfig: AthenaSourceConfig?{RoleArn: str?, DatabaseName: str?, DataCatalog: str?, TableName: str?, WorkGroupName: str?, S3ResultsPath: str?, BackTestConfiguration: BackTestConfiguration?{RunBackTestMode: bool}}}, DimensionFilterList: [MetricSetDimensionFilter]?}\n\n@endgroup\n\n@group DetectMetricSetConfig\n@endpoint POST /DetectMetricSetConfig\n@desc Detects an Amazon S3 dataset's file format, interval, and offset.\n@required {AnomalyDetectorArn: str, AutoDetectionMetricSource: AutoDetectionMetricSource}\n@returns(200) {DetectedMetricSetConfig: DetectedMetricSetConfig?{Offset: DetectedField?{Value: AttributeValue?{S: str?, N: str?, B: str?, SS: [str]?, NS: [str]?, BS: [str]?}, Confidence: str?, Message: str?}, MetricSetFrequency: DetectedField?{Value: AttributeValue?{S: str?, N: str?, B: str?, SS: [str]?, NS: [str]?, BS: [str]?}, Confidence: str?, Message: str?}, MetricSource: DetectedMetricSource?{S3SourceConfig: DetectedS3SourceConfig?{FileFormatDescriptor: DetectedFileFormatDescriptor?}}}}\n\n@endgroup\n\n@group GetAnomalyGroup\n@endpoint POST /GetAnomalyGroup\n@desc Returns details about a group of anomalous metrics.\n@required {AnomalyGroupId: str, AnomalyDetectorArn: str}\n@returns(200) {AnomalyGroup: AnomalyGroup?{StartTime: str?, EndTime: str?, AnomalyGroupId: str?, AnomalyGroupScore: num(f64)?, PrimaryMetricName: str?, MetricLevelImpactList: [MetricLevelImpact]?}}\n\n@endgroup\n\n@group GetDataQualityMetrics\n@endpoint POST /GetDataQualityMetrics\n@desc Returns details about the requested data quality metrics.\n@required {AnomalyDetectorArn: str}\n@optional {MetricSetArn: str}\n@returns(200) {AnomalyDetectorDataQualityMetricList: [AnomalyDetectorDataQualityMetric]?}\n\n@endgroup\n\n@group GetFeedback\n@endpoint POST /GetFeedback\n@desc Get feedback for an anomaly group.\n@required {AnomalyDetectorArn: str, AnomalyGroupTimeSeriesFeedback: AnomalyGroupTimeSeries}\n@optional {MaxResults: int, NextToken: str}\n@returns(200) {AnomalyGroupTimeSeriesFeedback: [TimeSeriesFeedback]?, NextToken: str?}\n\n@endgroup\n\n@group GetSampleData\n@endpoint POST /GetSampleData\n@desc Returns a selection of sample records from an Amazon S3 datasource.\n@optional {S3SourceConfig: SampleDataS3SourceConfig}\n@returns(200) {HeaderValues: [str]?, SampleRows: [[str]]?}\n\n@endgroup\n\n@group ListAlerts\n@endpoint POST /ListAlerts\n@desc 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.\n@optional {AnomalyDetectorArn: str, NextToken: str, MaxResults: int}\n@returns(200) {AlertSummaryList: [AlertSummary]?, NextToken: str?}\n\n@endgroup\n\n@group ListAnomalyDetectors\n@endpoint POST /ListAnomalyDetectors\n@desc Lists the detectors in the current AWS Region. 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.\n@optional {MaxResults: int, NextToken: str}\n@returns(200) {AnomalyDetectorSummaryList: [AnomalyDetectorSummary]?, NextToken: str?}\n\n@endgroup\n\n@group ListAnomalyGroupRelatedMetrics\n@endpoint POST /ListAnomalyGroupRelatedMetrics\n@desc Returns a list of measures that are potential causes or effects of an anomaly group.\n@required {AnomalyDetectorArn: str, AnomalyGroupId: str}\n@optional {RelationshipTypeFilter: str, MaxResults: int, NextToken: str}\n@returns(200) {InterMetricImpactList: [InterMetricImpactDetails]?, NextToken: str?}\n\n@endgroup\n\n@group ListAnomalyGroupSummaries\n@endpoint POST /ListAnomalyGroupSummaries\n@desc Returns a list of anomaly groups.\n@required {AnomalyDetectorArn: str, SensitivityThreshold: int}\n@optional {MaxResults: int, NextToken: str}\n@returns(200) {AnomalyGroupSummaryList: [AnomalyGroupSummary]?, AnomalyGroupStatistics: AnomalyGroupStatistics?{EvaluationStartDate: str?, TotalCount: int?, ItemizedMetricStatsList: [ItemizedMetricStats]?}, NextToken: str?}\n\n@endgroup\n\n@group ListAnomalyGroupTimeSeries\n@endpoint POST /ListAnomalyGroupTimeSeries\n@desc Gets a list of anomalous metrics for a measure in an anomaly group.\n@required {AnomalyDetectorArn: str, AnomalyGroupId: str, MetricName: str}\n@optional {MaxResults: int, NextToken: str}\n@returns(200) {AnomalyGroupId: str?, MetricName: str?, TimestampList: [str]?, NextToken: str?, TimeSeriesList: [TimeSeries]?}\n\n@endgroup\n\n@group ListMetricSets\n@endpoint POST /ListMetricSets\n@desc Lists the datasets in the current AWS Region. 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.\n@optional {AnomalyDetectorArn: str, MaxResults: int, NextToken: str}\n@returns(200) {MetricSetSummaryList: [MetricSetSummary]?, NextToken: str?}\n\n@endgroup\n\n@group tags\n@endpoint GET /tags/{resourceArn}\n@desc Gets a list of tags for a detector, dataset, or alert.\n@required {ResourceArn: str}\n@returns(200) {Tags: map<str,str>?}\n\n@endgroup\n\n@group PutFeedback\n@endpoint POST /PutFeedback\n@desc Add feedback for an anomalous metric.\n@required {AnomalyDetectorArn: str, AnomalyGroupTimeSeriesFeedback: AnomalyGroupTimeSeriesFeedback}\n\n@endgroup\n\n@group tags\n@endpoint POST /tags/{resourceArn}\n@desc Adds tags to a detector, dataset, or alert.\n@required {ResourceArn: str, Tags: map<str,str>}\n\n@endpoint DELETE /tags/{resourceArn}\n@desc Removes tags from a detector, dataset, or alert.\n@required {ResourceArn: str, tagKeys: [str]}\n\n@endgroup\n\n@group UpdateAlert\n@endpoint POST /UpdateAlert\n@desc Make changes to an existing alert.\n@required {AlertArn: str}\n@optional {AlertDescription: str, AlertSensitivityThreshold: int, Action: Action, AlertFilters: AlertFilters}\n@returns(200) {AlertArn: str?}\n\n@endgroup\n\n@group UpdateAnomalyDetector\n@endpoint POST /UpdateAnomalyDetector\n@desc Updates a detector. After activation, you can only change a detector's ingestion delay and description.\n@required {AnomalyDetectorArn: str}\n@optional {KmsKeyArn: str, AnomalyDetectorDescription: str, AnomalyDetectorConfig: AnomalyDetectorConfig}\n@returns(200) {AnomalyDetectorArn: str?}\n\n@endgroup\n\n@group UpdateMetricSet\n@endpoint POST /UpdateMetricSet\n@desc Updates a dataset.\n@required {MetricSetArn: str}\n@optional {MetricSetDescription: str, MetricList: [Metric], Offset: int, TimestampColumn: TimestampColumn, DimensionList: [str], MetricSetFrequency: str, MetricSource: MetricSource, DimensionFilterList: [MetricSetDimensionFilter]}\n@returns(200) {MetricSetArn: str?}\n\n@endgroup\n\n@end\n"}