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.
", "operations": { "ActivateAnomalyDetector": "Activates an anomaly detector.
", "BackTestAnomalyDetector": "Runs a backtest for anomaly detection for the specified resource.
", "CreateAlert": "Creates an alert for an anomaly detector.
", "CreateAnomalyDetector": "Creates an anomaly detector.
", "CreateMetricSet": "Creates a dataset.
", "DeactivateAnomalyDetector": "Deactivates an anomaly detector.
", "DeleteAlert": "Deletes an alert.
", "DeleteAnomalyDetector": "Deletes a detector. Deleting an anomaly detector will delete all of its corresponding resources including any configured datasets and alerts.
", "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.
", "DescribeAnomalyDetectionExecutions": "Returns information about the status of the specified anomaly detection jobs.
", "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.
", "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.
", "GetAnomalyGroup": "Returns details about a group of anomalous metrics.
", "GetFeedback": "Get feedback for an anomaly group.
", "GetSampleData": "Returns a selection of sample records from an Amazon S3 datasource.
", "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.
", "ListAnomalyDetectors": "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.
", "ListAnomalyGroupRelatedMetrics": "Returns a list of measures that are potential causes or effects of an anomaly group.
", "ListAnomalyGroupSummaries": "Returns a list of anomaly groups.
", "ListAnomalyGroupTimeSeries": "Gets a list of anomalous metrics for a measure in an anomaly group.
", "ListMetricSets": "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.
", "ListTagsForResource": "Gets a list of tags for a detector, dataset, or alert.
", "PutFeedback": "Add feedback for an anomalous metric.
", "TagResource": "Adds tags to a detector, dataset, or alert.
", "UntagResource": "Removes tags from a detector, dataset, or alert.
", "UpdateAnomalyDetector": "Updates a detector. After activation, you can only change a detector's ingestion delay and description.
", "UpdateMetricSet": "Updates a dataset.
" }, "shapes": { "AccessDeniedException": { "base": "You do not have sufficient permissions to perform this action.
", "refs": { } }, "Action": { "base": "A configuration that specifies the action to perform when anomalies are detected.
", "refs": { "Alert$Action": "Action that will be triggered when there is an alert.
", "CreateAlertRequest$Action": "Action that will be triggered when there is an alert.
" } }, "ActivateAnomalyDetectorRequest": { "base": null, "refs": { } }, "ActivateAnomalyDetectorResponse": { "base": null, "refs": { } }, "AggregationFunction": { "base": null, "refs": { "Metric$AggregationFunction": "The function with which the metric is calculated.
" } }, "Alert": { "base": "A configuration for Amazon SNS-integrated notifications.
", "refs": { "DescribeAlertResponse$Alert": "Contains information about an alert.
" } }, "AlertDescription": { "base": null, "refs": { "Alert$AlertDescription": "A description of the alert.
", "CreateAlertRequest$AlertDescription": "A description of the alert.
" } }, "AlertName": { "base": null, "refs": { "Alert$AlertName": "The name of the alert.
", "AlertSummary$AlertName": "The name of the alert.
", "CreateAlertRequest$AlertName": "The name of the alert.
" } }, "AlertStatus": { "base": null, "refs": { "Alert$AlertStatus": "The status of the alert.
", "AlertSummary$AlertStatus": "The status of the alert.
" } }, "AlertSummary": { "base": "Provides a summary of an alert's configuration.
", "refs": { "AlertSummaryList$member": null } }, "AlertSummaryList": { "base": null, "refs": { "ListAlertsResponse$AlertSummaryList": "Contains information about an alert.
" } }, "AlertType": { "base": null, "refs": { "Alert$AlertType": "The type of the alert.
", "AlertSummary$AlertType": "The type of the alert.
" } }, "AnomalyDetectionTaskStatus": { "base": null, "refs": { "ExecutionStatus$Status": "The run's status.
" } }, "AnomalyDetectionTaskStatusMessage": { "base": null, "refs": { "ExecutionStatus$FailureReason": "The reason that the run failed, if applicable.
" } }, "AnomalyDetectorConfig": { "base": "Contains information about a detector's configuration.
", "refs": { "CreateAnomalyDetectorRequest$AnomalyDetectorConfig": "Contains information about the configuration of the anomaly detector.
", "UpdateAnomalyDetectorRequest$AnomalyDetectorConfig": "Contains information about the configuration to which the detector will be updated.
" } }, "AnomalyDetectorConfigSummary": { "base": "Contains information about a detector's configuration.
", "refs": { "DescribeAnomalyDetectorResponse$AnomalyDetectorConfig": "Contains information about the detector's configuration.
" } }, "AnomalyDetectorDescription": { "base": null, "refs": { "AnomalyDetectorSummary$AnomalyDetectorDescription": "A description of the detector.
", "CreateAnomalyDetectorRequest$AnomalyDetectorDescription": "A description of the detector.
", "DescribeAnomalyDetectorResponse$AnomalyDetectorDescription": "A description of the detector.
", "UpdateAnomalyDetectorRequest$AnomalyDetectorDescription": "The updated detector description.
" } }, "AnomalyDetectorFailureType": { "base": null, "refs": { "DescribeAnomalyDetectorResponse$FailureType": "The process that caused the detector to fail.
" } }, "AnomalyDetectorName": { "base": null, "refs": { "AnomalyDetectorSummary$AnomalyDetectorName": "The name of the detector.
", "CreateAnomalyDetectorRequest$AnomalyDetectorName": "The name of the detector.
", "DescribeAnomalyDetectorResponse$AnomalyDetectorName": "The name of the detector.
" } }, "AnomalyDetectorStatus": { "base": null, "refs": { "AnomalyDetectorSummary$Status": "The status of detector.
", "DescribeAnomalyDetectorResponse$Status": "The status of the detector.
" } }, "AnomalyDetectorSummary": { "base": "Contains information about an an anomaly detector.
", "refs": { "AnomalyDetectorSummaryList$member": null } }, "AnomalyDetectorSummaryList": { "base": null, "refs": { "ListAnomalyDetectorsResponse$AnomalyDetectorSummaryList": "A list of anomaly detectors in the account in the current region.
" } }, "AnomalyGroup": { "base": "A group of anomalous metrics
", "refs": { "GetAnomalyGroupResponse$AnomalyGroup": "Details about the anomaly group.
" } }, "AnomalyGroupStatistics": { "base": "Aggregated statistics for a group of anomalous metrics.
", "refs": { "ListAnomalyGroupSummariesResponse$AnomalyGroupStatistics": "Aggregated details about the anomaly groups.
" } }, "AnomalyGroupSummary": { "base": "Details about a group of anomalous metrics.
", "refs": { "AnomalyGroupSummaryList$member": null } }, "AnomalyGroupSummaryList": { "base": null, "refs": { "ListAnomalyGroupSummariesResponse$AnomalyGroupSummaryList": "A list of anomaly group summaries.
" } }, "AnomalyGroupTimeSeries": { "base": "An anomalous metric in an anomaly group.
", "refs": { "GetFeedbackRequest$AnomalyGroupTimeSeriesFeedback": "The anomalous metric and group ID.
" } }, "AnomalyGroupTimeSeriesFeedback": { "base": "Feedback for an anomalous metric.
", "refs": { "PutFeedbackRequest$AnomalyGroupTimeSeriesFeedback": "Feedback for an anomalous metric.
" } }, "AppFlowConfig": { "base": "Details about an Amazon AppFlow flow datasource.
", "refs": { "MetricSource$AppFlowConfig": "An object containing information about the AppFlow configuration.
" } }, "Arn": { "base": null, "refs": { "ActivateAnomalyDetectorRequest$AnomalyDetectorArn": "The ARN of the anomaly detector.
", "Alert$AlertArn": "The ARN of the alert.
", "Alert$AnomalyDetectorArn": "The ARN of the detector to which the alert is attached.
", "AlertSummary$AlertArn": "The ARN of the alert.
", "AlertSummary$AnomalyDetectorArn": "The ARN of the detector to which the alert is attached.
", "AnomalyDetectorSummary$AnomalyDetectorArn": "The ARN of the detector.
", "AppFlowConfig$RoleArn": "An IAM role that gives Amazon Lookout for Metrics permission to access the flow.
", "BackTestAnomalyDetectorRequest$AnomalyDetectorArn": "The Amazon Resource Name (ARN) of the anomaly detector.
", "CloudWatchConfig$RoleArn": "An IAM role that gives Amazon Lookout for Metrics permission to access data in Amazon CloudWatch.
", "CreateAlertRequest$AnomalyDetectorArn": "The ARN of the detector to which the alert is attached.
", "CreateAlertResponse$AlertArn": "The ARN of the alert.
", "CreateAnomalyDetectorResponse$AnomalyDetectorArn": "The ARN of the detector.
", "CreateMetricSetRequest$AnomalyDetectorArn": "The ARN of the anomaly detector that will use the dataset.
", "CreateMetricSetResponse$MetricSetArn": "The ARN of the dataset.
", "DeactivateAnomalyDetectorRequest$AnomalyDetectorArn": "The Amazon Resource Name (ARN) of the anomaly detector.
", "DeleteAlertRequest$AlertArn": "The ARN of the alert to delete.
", "DeleteAnomalyDetectorRequest$AnomalyDetectorArn": "The ARN of the detector to delete.
", "DescribeAlertRequest$AlertArn": "The ARN of the alert to describe.
", "DescribeAnomalyDetectionExecutionsRequest$AnomalyDetectorArn": "The Amazon Resource Name (ARN) of the anomaly detector.
", "DescribeAnomalyDetectorRequest$AnomalyDetectorArn": "The ARN of the detector to describe.
", "DescribeAnomalyDetectorResponse$AnomalyDetectorArn": "The ARN of the detector.
", "DescribeMetricSetRequest$MetricSetArn": "The ARN of the dataset.
", "DescribeMetricSetResponse$MetricSetArn": "The ARN of the dataset.
", "DescribeMetricSetResponse$AnomalyDetectorArn": "The ARN of the detector that contains the dataset.
", "GetAnomalyGroupRequest$AnomalyDetectorArn": "The Amazon Resource Name (ARN) of the anomaly detector.
", "GetFeedbackRequest$AnomalyDetectorArn": "The Amazon Resource Name (ARN) of the anomaly detector.
", "LambdaConfiguration$RoleArn": "The ARN of an IAM role that has permission to invoke the Lambda function.
", "LambdaConfiguration$LambdaArn": "The ARN of the Lambda function.
", "ListAlertsRequest$AnomalyDetectorArn": "The ARN of the alert's detector.
", "ListAnomalyGroupRelatedMetricsRequest$AnomalyDetectorArn": "The Amazon Resource Name (ARN) of the anomaly detector.
", "ListAnomalyGroupSummariesRequest$AnomalyDetectorArn": "The Amazon Resource Name (ARN) of the anomaly detector.
", "ListAnomalyGroupTimeSeriesRequest$AnomalyDetectorArn": "The Amazon Resource Name (ARN) of the anomaly detector.
", "ListMetricSetsRequest$AnomalyDetectorArn": "The ARN of the anomaly detector containing the metrics sets to list.
", "ListTagsForResourceRequest$ResourceArn": "The resource's Amazon Resource Name (ARN).
", "MetricSetSummary$MetricSetArn": "The ARN of the dataset.
", "MetricSetSummary$AnomalyDetectorArn": "The ARN of the detector to which the dataset belongs.
", "PutFeedbackRequest$AnomalyDetectorArn": "The Amazon Resource Name (ARN) of the anomaly detector.
", "RDSSourceConfig$RoleArn": "The Amazon Resource Name (ARN) of the role.
", "RedshiftSourceConfig$RoleArn": "The Amazon Resource Name (ARN) of the role providing access to the database.
", "S3SourceConfig$RoleArn": "The ARN of an IAM role that has read and write access permissions to the source S3 bucket.
", "SNSConfiguration$RoleArn": "The ARN of the IAM role that has access to the target SNS topic.
", "SNSConfiguration$SnsTopicArn": "The ARN of the target SNS topic.
", "SampleDataS3SourceConfig$RoleArn": "The Amazon Resource Name (ARN) of the role.
", "TagResourceRequest$ResourceArn": "The resource's Amazon Resource Name (ARN).
", "UntagResourceRequest$ResourceArn": "The resource's Amazon Resource Name (ARN).
", "UpdateAnomalyDetectorRequest$AnomalyDetectorArn": "The ARN of the detector to update.
", "UpdateAnomalyDetectorResponse$AnomalyDetectorArn": "The ARN of the updated detector.
", "UpdateMetricSetRequest$MetricSetArn": "The ARN of the dataset to update.
", "UpdateMetricSetResponse$MetricSetArn": "The ARN of the dataset.
" } }, "BackTestAnomalyDetectorRequest": { "base": null, "refs": { } }, "BackTestAnomalyDetectorResponse": { "base": null, "refs": { } }, "Boolean": { "base": null, "refs": { "AnomalyGroupTimeSeriesFeedback$IsAnomaly": "Feedback on whether the metric is a legitimate anomaly.
", "CsvFormatDescriptor$ContainsHeader": "Whether or not the source CSV file contains a header.
", "TimeSeriesFeedback$IsAnomaly": "Feedback on whether the metric is a legitimate anomaly.
" } }, "CSVFileCompression": { "base": null, "refs": { "CsvFormatDescriptor$FileCompression": "The level of compression of the source CSV file.
" } }, "Charset": { "base": null, "refs": { "CsvFormatDescriptor$Charset": "The character set in which the source CSV file is written.
", "JsonFormatDescriptor$Charset": "The character set in which the source JSON file is written.
" } }, "CloudWatchConfig": { "base": "Details about an Amazon CloudWatch datasource.
", "refs": { "MetricSource$CloudWatchConfig": "An object containing information about the Amazon CloudWatch monitoring configuration.
" } }, "ColumnName": { "base": null, "refs": { "DimensionContribution$DimensionName": "The name of the dimension.
", "DimensionList$member": null, "DimensionNameValue$DimensionName": "The name of the dimension.
", "HeaderList$member": null, "ItemizedMetricStats$MetricName": "The name of the measure.
", "Metric$MetricName": "The name of the metric.
", "TimestampColumn$ColumnName": "The name of the timestamp column.
" } }, "ConflictException": { "base": "There was a conflict processing the request. Try your request again.
", "refs": { } }, "ContributionMatrix": { "base": "Details about dimensions that contributed to an anomaly.
", "refs": { "MetricLevelImpact$ContributionMatrix": "Details about the dimensions that contributed to the anomaly.
" } }, "CreateAlertRequest": { "base": null, "refs": { } }, "CreateAlertResponse": { "base": null, "refs": { } }, "CreateAnomalyDetectorRequest": { "base": null, "refs": { } }, "CreateAnomalyDetectorResponse": { "base": null, "refs": { } }, "CreateMetricSetRequest": { "base": null, "refs": { } }, "CreateMetricSetResponse": { "base": null, "refs": { } }, "CsvFormatDescriptor": { "base": "Contains information about how a source CSV data file should be analyzed.
", "refs": { "FileFormatDescriptor$CsvFormatDescriptor": "Contains information about how a source CSV data file should be analyzed.
" } }, "DataItem": { "base": null, "refs": { "SampleRow$member": null } }, "DatabaseHost": { "base": null, "refs": { "RDSSourceConfig$DatabaseHost": "The host name of the database.
", "RedshiftSourceConfig$DatabaseHost": "The name of the database host.
" } }, "DatabasePort": { "base": null, "refs": { "RDSSourceConfig$DatabasePort": "The port number where the database can be accessed.
", "RedshiftSourceConfig$DatabasePort": "The port number where the database can be accessed.
" } }, "DateTimeFormat": { "base": null, "refs": { "TimestampColumn$ColumnFormat": "The format of the timestamp column.
" } }, "DeactivateAnomalyDetectorRequest": { "base": null, "refs": { } }, "DeactivateAnomalyDetectorResponse": { "base": null, "refs": { } }, "DeleteAlertRequest": { "base": null, "refs": { } }, "DeleteAlertResponse": { "base": null, "refs": { } }, "DeleteAnomalyDetectorRequest": { "base": null, "refs": { } }, "DeleteAnomalyDetectorResponse": { "base": null, "refs": { } }, "Delimiter": { "base": null, "refs": { "CsvFormatDescriptor$Delimiter": "The character used to delimit the source CSV file.
" } }, "DescribeAlertRequest": { "base": null, "refs": { } }, "DescribeAlertResponse": { "base": null, "refs": { } }, "DescribeAnomalyDetectionExecutionsRequest": { "base": null, "refs": { } }, "DescribeAnomalyDetectionExecutionsResponse": { "base": null, "refs": { } }, "DescribeAnomalyDetectorRequest": { "base": null, "refs": { } }, "DescribeAnomalyDetectorResponse": { "base": null, "refs": { } }, "DescribeMetricSetRequest": { "base": null, "refs": { } }, "DescribeMetricSetResponse": { "base": null, "refs": { } }, "DimensionContribution": { "base": "Details about a dimension that contributed to an anomaly.
", "refs": { "DimensionContributionList$member": null } }, "DimensionContributionList": { "base": null, "refs": { "ContributionMatrix$DimensionContributionList": "A list of contributing dimensions.
" } }, "DimensionList": { "base": null, "refs": { "CreateMetricSetRequest$DimensionList": "A list of the fields you want to treat as dimensions.
", "DescribeMetricSetResponse$DimensionList": "A list of the dimensions chosen for analysis.
", "UpdateMetricSetRequest$DimensionList": "The dimension list.
" } }, "DimensionNameValue": { "base": "A dimension name and value.
", "refs": { "DimensionNameValueList$member": null } }, "DimensionNameValueList": { "base": null, "refs": { "TimeSeries$DimensionList": "The dimensions of the metric.
" } }, "DimensionValue": { "base": null, "refs": { "DimensionNameValue$DimensionValue": "The value of the dimension.
", "DimensionValueContribution$DimensionValue": "The value of the dimension.
" } }, "DimensionValueContribution": { "base": "The severity of a value of a dimension that contributed to an anomaly.
", "refs": { "DimensionValueContributionList$member": null } }, "DimensionValueContributionList": { "base": null, "refs": { "DimensionContribution$DimensionValueContributionList": "A list of dimension values that contributed to the anomaly.
" } }, "ErrorMessage": { "base": null, "refs": { "DescribeAnomalyDetectorResponse$FailureReason": "The reason that the detector failed.
" } }, "ExecutionList": { "base": null, "refs": { "DescribeAnomalyDetectionExecutionsResponse$ExecutionList": "A list of detection jobs.
" } }, "ExecutionStatus": { "base": "The status of an anomaly detector run.
", "refs": { "ExecutionList$member": null } }, "FieldName": { "base": null, "refs": { "ValidationExceptionField$Name": "The name of the field.
" } }, "FileFormatDescriptor": { "base": "Contains information about a source file's formatting.
", "refs": { "S3SourceConfig$FileFormatDescriptor": "Contains information about a source file's formatting.
", "SampleDataS3SourceConfig$FileFormatDescriptor": null } }, "FlowName": { "base": null, "refs": { "AppFlowConfig$FlowName": "name of the flow.
" } }, "Frequency": { "base": null, "refs": { "AnomalyDetectorConfig$AnomalyDetectorFrequency": "The frequency at which the detector analyzes its source data.
", "AnomalyDetectorConfigSummary$AnomalyDetectorFrequency": "The interval at which the detector analyzes its source data.
", "CreateMetricSetRequest$MetricSetFrequency": "The frequency with which the source data will be analyzed for anomalies.
", "DescribeMetricSetResponse$MetricSetFrequency": "The interval at which the data will be analyzed for anomalies.
", "UpdateMetricSetRequest$MetricSetFrequency": "The dataset's interval.
" } }, "GetAnomalyGroupRequest": { "base": null, "refs": { } }, "GetAnomalyGroupResponse": { "base": null, "refs": { } }, "GetFeedbackRequest": { "base": null, "refs": { } }, "GetFeedbackResponse": { "base": null, "refs": { } }, "GetSampleDataRequest": { "base": null, "refs": { } }, "GetSampleDataResponse": { "base": null, "refs": { } }, "HeaderList": { "base": null, "refs": { "CsvFormatDescriptor$HeaderList": "A list of the source CSV file's headers, if any.
" } }, "HeaderValue": { "base": null, "refs": { "HeaderValueList$member": null } }, "HeaderValueList": { "base": null, "refs": { "GetSampleDataResponse$HeaderValues": "A list of header labels for the records.
" } }, "HistoricalDataPath": { "base": null, "refs": { "HistoricalDataPathList$member": null } }, "HistoricalDataPathList": { "base": null, "refs": { "S3SourceConfig$HistoricalDataPathList": "A list of paths to the historical data files.
", "SampleDataS3SourceConfig$HistoricalDataPathList": "An array of strings containing the historical set of data paths.
" } }, "Integer": { "base": null, "refs": { "AnomalyGroupStatistics$TotalCount": "The number of groups found.
", "ItemizedMetricStats$OccurrenceCount": "The number of times that the measure appears.
", "MetricLevelImpact$NumTimeSeries": "The number of anomalous metrics for the measure.
" } }, "InterMetricImpactDetails": { "base": "Aggregated details about the measures contributing to the anomaly group, and the measures potentially impacted by the anomaly group.
", "refs": { "InterMetricImpactList$member": null } }, "InterMetricImpactList": { "base": null, "refs": { "ListAnomalyGroupRelatedMetricsResponse$InterMetricImpactList": "Aggregated details about the measures contributing to the anomaly group, and the measures potentially impacted by the anomaly group.
" } }, "InternalServerException": { "base": "The request processing has failed because of an unknown error, exception, or failure.
", "refs": { } }, "ItemizedMetricStats": { "base": "Aggregated statistics about a measure affected by an anomaly.
", "refs": { "ItemizedMetricStatsList$member": null } }, "ItemizedMetricStatsList": { "base": null, "refs": { "AnomalyGroupStatistics$ItemizedMetricStatsList": "Statistics for individual metrics within the group.
" } }, "JsonFileCompression": { "base": null, "refs": { "JsonFormatDescriptor$FileCompression": "The level of compression of the source CSV file.
" } }, "JsonFormatDescriptor": { "base": "Contains information about how a source JSON data file should be analyzed.
", "refs": { "FileFormatDescriptor$JsonFormatDescriptor": "Contains information about how a source JSON data file should be analyzed.
" } }, "KmsKeyArn": { "base": null, "refs": { "CreateAnomalyDetectorRequest$KmsKeyArn": "The ARN of the KMS key to use to encrypt your data.
", "DescribeAnomalyDetectorResponse$KmsKeyArn": "The ARN of the KMS key to use to encrypt your data.
", "UpdateAnomalyDetectorRequest$KmsKeyArn": "The Amazon Resource Name (ARN) of an AWS KMS encryption key.
" } }, "LambdaConfiguration": { "base": "Contains information about a Lambda configuration.
", "refs": { "Action$LambdaConfiguration": "A configuration for an AWS Lambda channel.
" } }, "ListAlertsRequest": { "base": null, "refs": { } }, "ListAlertsResponse": { "base": null, "refs": { } }, "ListAnomalyDetectorsRequest": { "base": null, "refs": { } }, "ListAnomalyDetectorsResponse": { "base": null, "refs": { } }, "ListAnomalyGroupRelatedMetricsRequest": { "base": null, "refs": { } }, "ListAnomalyGroupRelatedMetricsResponse": { "base": null, "refs": { } }, "ListAnomalyGroupSummariesRequest": { "base": null, "refs": { } }, "ListAnomalyGroupSummariesResponse": { "base": null, "refs": { } }, "ListAnomalyGroupTimeSeriesRequest": { "base": null, "refs": { } }, "ListAnomalyGroupTimeSeriesResponse": { "base": null, "refs": { } }, "ListMetricSetsRequest": { "base": null, "refs": { } }, "ListMetricSetsResponse": { "base": null, "refs": { } }, "ListTagsForResourceRequest": { "base": null, "refs": { } }, "ListTagsForResourceResponse": { "base": null, "refs": { } }, "MaxResults": { "base": null, "refs": { "DescribeAnomalyDetectionExecutionsRequest$MaxResults": "The number of items to return in the response.
", "GetFeedbackRequest$MaxResults": "The maximum number of results to return.
", "ListAlertsRequest$MaxResults": "The maximum number of results that will be displayed by the request.
", "ListAnomalyDetectorsRequest$MaxResults": "The maximum number of results to return.
", "ListAnomalyGroupRelatedMetricsRequest$MaxResults": "The maximum number of results to return.
", "ListAnomalyGroupSummariesRequest$MaxResults": "The maximum number of results to return.
", "ListAnomalyGroupTimeSeriesRequest$MaxResults": "The maximum number of results to return.
", "ListMetricSetsRequest$MaxResults": "The maximum number of results to return.
" } }, "Message": { "base": null, "refs": { "AccessDeniedException$Message": null, "ConflictException$Message": null, "InternalServerException$Message": null, "ResourceNotFoundException$Message": null, "ServiceQuotaExceededException$Message": null, "TooManyRequestsException$Message": null, "ValidationException$Message": null, "ValidationExceptionField$Message": "The message with more information about the validation exception.
" } }, "Metric": { "base": "A calculation made by contrasting a measure and a dimension from your source data.
", "refs": { "MetricList$member": null } }, "MetricChangePercentage": { "base": null, "refs": { "InterMetricImpactDetails$ContributionPercentage": "For potential causes (CAUSE_OF_INPUT_ANOMALY_GROUP), the percentage contribution the measure has in causing the anomalies.
Details about a measure affected by an anomaly.
", "refs": { "MetricLevelImpactList$member": null } }, "MetricLevelImpactList": { "base": null, "refs": { "AnomalyGroup$MetricLevelImpactList": "A list of measures affected by the anomaly.
" } }, "MetricList": { "base": null, "refs": { "CreateMetricSetRequest$MetricList": "A list of metrics that the dataset will contain.
", "DescribeMetricSetResponse$MetricList": "A list of the metrics defined by the dataset.
", "UpdateMetricSetRequest$MetricList": "The metric list.
" } }, "MetricName": { "base": null, "refs": { "AnomalyGroup$PrimaryMetricName": "The name of the primary affected measure for the group.
", "AnomalyGroupSummary$PrimaryMetricName": "The name of the primary affected measure for the group.
", "InterMetricImpactDetails$MetricName": "The name of the measure.
", "ListAnomalyGroupTimeSeriesRequest$MetricName": "The name of the measure field.
", "ListAnomalyGroupTimeSeriesResponse$MetricName": "The name of the measure field.
", "MetricLevelImpact$MetricName": "The name of the measure.
" } }, "MetricSetDescription": { "base": null, "refs": { "CreateMetricSetRequest$MetricSetDescription": "A description of the dataset you are creating.
", "DescribeMetricSetResponse$MetricSetDescription": "The dataset's description.
", "MetricSetSummary$MetricSetDescription": "The description of the dataset.
", "UpdateMetricSetRequest$MetricSetDescription": "The dataset's description.
" } }, "MetricSetName": { "base": null, "refs": { "CreateMetricSetRequest$MetricSetName": "The name of the dataset.
", "DescribeMetricSetResponse$MetricSetName": "The name of the dataset.
", "MetricSetSummary$MetricSetName": "The name of the dataset.
" } }, "MetricSetSummary": { "base": "Contains information about a dataset.
", "refs": { "MetricSetSummaryList$member": null } }, "MetricSetSummaryList": { "base": null, "refs": { "ListMetricSetsResponse$MetricSetSummaryList": "A list of the datasets in the AWS Region, with configuration details for each.
" } }, "MetricSource": { "base": "Contains information about source data used to generate a metric.
", "refs": { "CreateMetricSetRequest$MetricSource": "Contains information about how the source data should be interpreted.
", "DescribeMetricSetResponse$MetricSource": "Contains information about the dataset's source data.
", "UpdateMetricSetRequest$MetricSource": null } }, "MetricValue": { "base": null, "refs": { "MetricValueList$member": null } }, "MetricValueList": { "base": null, "refs": { "TimeSeries$MetricValueList": "The values for the metric.
" } }, "Namespace": { "base": null, "refs": { "Metric$Namespace": "The namespace for the metric.
" } }, "NextToken": { "base": null, "refs": { "DescribeAnomalyDetectionExecutionsRequest$NextToken": "Specify the pagination token that's returned by a previous request to retrieve the next page of results.
", "DescribeAnomalyDetectionExecutionsResponse$NextToken": "The pagination token that's included if more results are available.
", "GetFeedbackRequest$NextToken": "Specify the pagination token that's returned by a previous request to retrieve the next page of results.
", "GetFeedbackResponse$NextToken": "The pagination token that's included if more results are available.
", "ListAlertsRequest$NextToken": "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.
If the response is truncated, the service returns this token. To retrieve the next set of results, use this token in the next request.
", "ListAnomalyDetectorsRequest$NextToken": "If the result of the previous request was 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.
If the response is truncated, the service returns this token. To retrieve the next set of results, use the token in the next request.
", "ListAnomalyGroupRelatedMetricsRequest$NextToken": "Specify the pagination token that's returned by a previous request to retrieve the next page of results.
", "ListAnomalyGroupRelatedMetricsResponse$NextToken": "The pagination token that's included if more results are available.
", "ListAnomalyGroupSummariesRequest$NextToken": "Specify the pagination token that's returned by a previous request to retrieve the next page of results.
", "ListAnomalyGroupSummariesResponse$NextToken": "The pagination token that's included if more results are available.
", "ListAnomalyGroupTimeSeriesRequest$NextToken": "Specify the pagination token that's returned by a previous request to retrieve the next page of results.
", "ListAnomalyGroupTimeSeriesResponse$NextToken": "The pagination token that's included if more results are available.
", "ListMetricSetsRequest$NextToken": "If the result of the previous request was 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.
If the response is truncated, the list call returns this token. To retrieve the next set of results, use the token in the next list request.
" } }, "Offset": { "base": null, "refs": { "CreateMetricSetRequest$Offset": "After an interval ends, the amount of seconds that the detector waits before importing data. Offset is only supported for S3 and Redshift datasources.
", "DescribeMetricSetResponse$Offset": "The offset in seconds. Only supported for S3 and Redshift datasources.
", "UpdateMetricSetRequest$Offset": "After an interval ends, the amount of seconds that the detector waits before importing data. Offset is only supported for S3 and Redshift datasources.
" } }, "PoirotSecretManagerArn": { "base": null, "refs": { "RDSSourceConfig$SecretManagerArn": "The Amazon Resource Name (ARN) of the AWS Secrets Manager role.
", "RedshiftSourceConfig$SecretManagerArn": "The Amazon Resource Name (ARN) of the AWS Secrets Manager role.
" } }, "PutFeedbackRequest": { "base": null, "refs": { } }, "PutFeedbackResponse": { "base": null, "refs": { } }, "QuotaCode": { "base": null, "refs": { "ServiceQuotaExceededException$QuotaCode": "The quota code.
" } }, "QuoteSymbol": { "base": null, "refs": { "CsvFormatDescriptor$QuoteSymbol": "The character used as a quote character.
" } }, "RDSDatabaseIdentifier": { "base": null, "refs": { "RDSSourceConfig$DBInstanceIdentifier": "A string identifying the database instance.
" } }, "RDSDatabaseName": { "base": null, "refs": { "RDSSourceConfig$DatabaseName": "The name of the RDS database.
" } }, "RDSSourceConfig": { "base": "Contains information about the Amazon Relational Database Service (RDS) configuration.
", "refs": { "MetricSource$RDSSourceConfig": "An object containing information about the Amazon Relational Database Service (RDS) configuration.
" } }, "RedshiftClusterIdentifier": { "base": null, "refs": { "RedshiftSourceConfig$ClusterIdentifier": "A string identifying the Redshift cluster.
" } }, "RedshiftDatabaseName": { "base": null, "refs": { "RedshiftSourceConfig$DatabaseName": "The Redshift database name.
" } }, "RedshiftSourceConfig": { "base": "Provides information about the Amazon Redshift database configuration.
", "refs": { "MetricSource$RedshiftSourceConfig": "An object containing information about the Amazon Redshift database configuration.
" } }, "RelationshipType": { "base": null, "refs": { "InterMetricImpactDetails$RelationshipType": "Whether a measure is a potential cause of the anomaly group (CAUSE_OF_INPUT_ANOMALY_GROUP), or whether the measure is impacted by the anomaly group (EFFECT_OF_INPUT_ANOMALY_GROUP).
Filter for potential causes (CAUSE_OF_INPUT_ANOMALY_GROUP) or downstream effects (EFFECT_OF_INPUT_ANOMALY_GROUP) of the anomaly group.
The ID of the resource.
", "ResourceNotFoundException$ResourceId": "The ID of the resource.
", "ServiceQuotaExceededException$ResourceId": "The ID of the resource.
" } }, "ResourceNotFoundException": { "base": "The specified resource cannot be found. Check the ARN of the resource and try again.
", "refs": { } }, "ResourceType": { "base": null, "refs": { "ConflictException$ResourceType": "The type of the resource.
", "ResourceNotFoundException$ResourceType": "The type of the resource.
", "ServiceQuotaExceededException$ResourceType": "The type of the resource.
" } }, "S3SourceConfig": { "base": "Contains information about the configuration of the S3 bucket that contains source files.
", "refs": { "MetricSource$S3SourceConfig": null } }, "SNSConfiguration": { "base": "Contains information about the SNS topic to which you want to send your alerts and the IAM role that has access to that topic.
", "refs": { "Action$SNSConfiguration": "A configuration for an Amazon SNS channel.
" } }, "SampleDataS3SourceConfig": { "base": "Contains information about the source configuration in Amazon S3.
", "refs": { "GetSampleDataRequest$S3SourceConfig": "A datasource bucket in Amazon S3.
" } }, "SampleRow": { "base": null, "refs": { "SampleRows$member": null } }, "SampleRows": { "base": null, "refs": { "GetSampleDataResponse$SampleRows": "A list of records.
" } }, "Score": { "base": null, "refs": { "AnomalyGroup$AnomalyGroupScore": "The severity score of the group.
", "AnomalyGroupSummary$AnomalyGroupScore": "The severity score of the group.
", "DimensionValueContribution$ContributionScore": "The severity score of the value.
" } }, "SecurityGroupId": { "base": null, "refs": { "SecurityGroupIdList$member": null } }, "SecurityGroupIdList": { "base": null, "refs": { "VpcConfiguration$SecurityGroupIdList": "An array of strings containing the list of security groups.
" } }, "SensitivityThreshold": { "base": null, "refs": { "Alert$AlertSensitivityThreshold": "The minimum severity for an anomaly to trigger the alert.
", "AlertSummary$AlertSensitivityThreshold": "The minimum severity for an anomaly to trigger the alert.
", "CreateAlertRequest$AlertSensitivityThreshold": "An integer from 0 to 100 specifying the alert sensitivity threshold.
", "ListAnomalyGroupSummariesRequest$SensitivityThreshold": "The minimum severity score for inclusion in the output.
" } }, "ServiceCode": { "base": null, "refs": { "ServiceQuotaExceededException$ServiceCode": "The service code.
" } }, "ServiceQuotaExceededException": { "base": "The request exceeded the service's quotas. Check the service quotas and try again.
", "refs": { } }, "SubnetId": { "base": null, "refs": { "SubnetIdList$member": null } }, "SubnetIdList": { "base": null, "refs": { "VpcConfiguration$SubnetIdList": "An array of strings containing the Amazon VPC subnet IDs (e.g., subnet-0bb1c79de3EXAMPLE.
The name of the table in the database.
", "RedshiftSourceConfig$TableName": "The table name of the Redshift database.
" } }, "TagKey": { "base": null, "refs": { "TagKeyList$member": null, "TagMap$key": null } }, "TagKeyList": { "base": null, "refs": { "UntagResourceRequest$TagKeys": "Keys to remove from the resource's tags.
" } }, "TagMap": { "base": null, "refs": { "AlertSummary$Tags": "The alert's tags.
", "AnomalyDetectorSummary$Tags": "The detector's tags.
", "CreateAlertRequest$Tags": "A list of tags to apply to the alert.
", "CreateAnomalyDetectorRequest$Tags": "A list of tags to apply to the anomaly detector.
", "CreateMetricSetRequest$Tags": "A list of tags to apply to the dataset.
", "ListTagsForResourceResponse$Tags": "The resource's tags.
", "MetricSetSummary$Tags": "The dataset's tags.
", "TagResourceRequest$Tags": "Tags to apply to the resource. Tag keys and values can contain letters, numbers, spaces, and the following symbols: _.:/=+@-
A list of templated paths to the source files.
", "SampleDataS3SourceConfig$TemplatedPathList": "An array of strings containing the list of templated paths.
" } }, "TimeSeries": { "base": "Details about a metric. A metric is an aggregation of the values of a measure for a dimension value, such as availability in the us-east-1 Region.
", "refs": { "TimeSeriesList$member": null } }, "TimeSeriesFeedback": { "base": "Details about feedback submitted for an anomalous metric.
", "refs": { "TimeSeriesFeedbackList$member": null } }, "TimeSeriesFeedbackList": { "base": null, "refs": { "GetFeedbackResponse$AnomalyGroupTimeSeriesFeedback": "Feedback for an anomalous metric.
" } }, "TimeSeriesId": { "base": null, "refs": { "AnomalyGroupTimeSeries$TimeSeriesId": "The ID of the metric.
", "AnomalyGroupTimeSeriesFeedback$TimeSeriesId": "The ID of the metric.
", "TimeSeries$TimeSeriesId": "The ID of the metric.
", "TimeSeriesFeedback$TimeSeriesId": "The ID of the metric.
" } }, "TimeSeriesList": { "base": null, "refs": { "ListAnomalyGroupTimeSeriesResponse$TimeSeriesList": "A list of anomalous metrics.
" } }, "Timestamp": { "base": null, "refs": { "Alert$LastModificationTime": "The time at which the alert was last modified.
", "Alert$CreationTime": "The time at which the alert was created.
", "AlertSummary$LastModificationTime": "The time at which the alert was last modified.
", "AlertSummary$CreationTime": "The time at which the alert was created.
", "AnomalyDetectorSummary$CreationTime": "The time at which the detector was created.
", "AnomalyDetectorSummary$LastModificationTime": "The time at which the detector was last modified.
", "DescribeAnomalyDetectorResponse$CreationTime": "The time at which the detector was created.
", "DescribeAnomalyDetectorResponse$LastModificationTime": "The time at which the detector was last modified.
", "DescribeMetricSetResponse$CreationTime": "The time at which the dataset was created.
", "DescribeMetricSetResponse$LastModificationTime": "The time at which the dataset was last modified.
", "MetricSetSummary$CreationTime": "The time at which the dataset was created.
", "MetricSetSummary$LastModificationTime": "The time at which the dataset was last modified.
" } }, "TimestampColumn": { "base": "Contains information about the column used to track time in a source data file.
", "refs": { "CreateMetricSetRequest$TimestampColumn": "Contains information about the column used for tracking time in your source data.
", "DescribeMetricSetResponse$TimestampColumn": "Contains information about the column used for tracking time in your source data.
", "UpdateMetricSetRequest$TimestampColumn": "The timestamp column.
" } }, "TimestampList": { "base": null, "refs": { "ListAnomalyGroupTimeSeriesResponse$TimestampList": "Timestamps for the anomalous metrics.
" } }, "TimestampString": { "base": null, "refs": { "AnomalyGroup$StartTime": "The start time for the group.
", "AnomalyGroup$EndTime": "The end time for the group.
", "AnomalyGroupStatistics$EvaluationStartDate": "The start of the time range that was searched.
", "AnomalyGroupSummary$StartTime": "The start time for the group.
", "AnomalyGroupSummary$EndTime": "The end time for the group.
", "DescribeAnomalyDetectionExecutionsRequest$Timestamp": "The timestamp of the anomaly detection job.
", "ExecutionStatus$Timestamp": "The run's timestamp.
", "TimestampList$member": null } }, "Timezone": { "base": null, "refs": { "CreateMetricSetRequest$Timezone": "The time zone in which your source data was recorded.
", "DescribeMetricSetResponse$Timezone": "The time zone in which the dataset's data was recorded.
" } }, "TooManyRequestsException": { "base": "The request was denied due to too many requests being submitted at the same time.
", "refs": { } }, "UUID": { "base": null, "refs": { "AnomalyGroup$AnomalyGroupId": "The ID of the anomaly group.
", "AnomalyGroupSummary$AnomalyGroupId": "The ID of the anomaly group.
", "AnomalyGroupTimeSeries$AnomalyGroupId": "The ID of the anomaly group.
", "AnomalyGroupTimeSeriesFeedback$AnomalyGroupId": "The ID of the anomaly group.
", "GetAnomalyGroupRequest$AnomalyGroupId": "The ID of the anomaly group.
", "InterMetricImpactDetails$AnomalyGroupId": "The ID of the anomaly group.
", "ListAnomalyGroupRelatedMetricsRequest$AnomalyGroupId": "The ID of the anomaly group.
", "ListAnomalyGroupTimeSeriesRequest$AnomalyGroupId": "The ID of the anomaly group.
", "ListAnomalyGroupTimeSeriesResponse$AnomalyGroupId": "The ID of the anomaly group.
" } }, "UntagResourceRequest": { "base": null, "refs": { } }, "UntagResourceResponse": { "base": null, "refs": { } }, "UpdateAnomalyDetectorRequest": { "base": null, "refs": { } }, "UpdateAnomalyDetectorResponse": { "base": null, "refs": { } }, "UpdateMetricSetRequest": { "base": null, "refs": { } }, "UpdateMetricSetResponse": { "base": null, "refs": { } }, "ValidationException": { "base": "The input fails to satisfy the constraints specified by the AWS service. Check your input values and try again.
", "refs": { } }, "ValidationExceptionField": { "base": "Contains information about a a field in a validation exception.
", "refs": { "ValidationExceptionFieldList$member": null } }, "ValidationExceptionFieldList": { "base": null, "refs": { "ValidationException$Fields": "Fields that failed validation.
" } }, "ValidationExceptionReason": { "base": null, "refs": { "ValidationException$Reason": "The reason that validation failed.
" } }, "VpcConfiguration": { "base": "Contains configuration information about the Amazon Virtual Private Cloud (VPC).
", "refs": { "RDSSourceConfig$VpcConfiguration": "An object containing information about the Amazon Virtual Private Cloud (VPC) configuration.
", "RedshiftSourceConfig$VpcConfiguration": "Contains information about the Amazon Virtual Private Cloud (VPC) configuration.
" } } } }