import {Request} from '../lib/request'; import {Response} from '../lib/response'; import {AWSError} from '../lib/error'; import {Service} from '../lib/service'; import {ServiceConfigurationOptions} from '../lib/service'; import {ConfigBase as Config} from '../lib/config-base'; interface Blob {} declare class LookoutMetrics extends Service { /** * Constructs a service object. This object has one method for each API operation. */ constructor(options?: LookoutMetrics.Types.ClientConfiguration) config: Config & LookoutMetrics.Types.ClientConfiguration; /** * Activates an anomaly detector. */ activateAnomalyDetector(params: LookoutMetrics.Types.ActivateAnomalyDetectorRequest, callback?: (err: AWSError, data: LookoutMetrics.Types.ActivateAnomalyDetectorResponse) => void): Request; /** * Activates an anomaly detector. */ activateAnomalyDetector(callback?: (err: AWSError, data: LookoutMetrics.Types.ActivateAnomalyDetectorResponse) => void): Request; /** * Runs a backtest for anomaly detection for the specified resource. */ backTestAnomalyDetector(params: LookoutMetrics.Types.BackTestAnomalyDetectorRequest, callback?: (err: AWSError, data: LookoutMetrics.Types.BackTestAnomalyDetectorResponse) => void): Request; /** * Runs a backtest for anomaly detection for the specified resource. */ backTestAnomalyDetector(callback?: (err: AWSError, data: LookoutMetrics.Types.BackTestAnomalyDetectorResponse) => void): Request; /** * Creates an alert for an anomaly detector. */ createAlert(params: LookoutMetrics.Types.CreateAlertRequest, callback?: (err: AWSError, data: LookoutMetrics.Types.CreateAlertResponse) => void): Request; /** * Creates an alert for an anomaly detector. */ createAlert(callback?: (err: AWSError, data: LookoutMetrics.Types.CreateAlertResponse) => void): Request; /** * Creates an anomaly detector. */ createAnomalyDetector(params: LookoutMetrics.Types.CreateAnomalyDetectorRequest, callback?: (err: AWSError, data: LookoutMetrics.Types.CreateAnomalyDetectorResponse) => void): Request; /** * Creates an anomaly detector. */ createAnomalyDetector(callback?: (err: AWSError, data: LookoutMetrics.Types.CreateAnomalyDetectorResponse) => void): Request; /** * Creates a dataset. */ createMetricSet(params: LookoutMetrics.Types.CreateMetricSetRequest, callback?: (err: AWSError, data: LookoutMetrics.Types.CreateMetricSetResponse) => void): Request; /** * Creates a dataset. */ createMetricSet(callback?: (err: AWSError, data: LookoutMetrics.Types.CreateMetricSetResponse) => void): Request; /** * Deletes an alert. */ deleteAlert(params: LookoutMetrics.Types.DeleteAlertRequest, callback?: (err: AWSError, data: LookoutMetrics.Types.DeleteAlertResponse) => void): Request; /** * Deletes an alert. */ deleteAlert(callback?: (err: AWSError, data: LookoutMetrics.Types.DeleteAlertResponse) => void): Request; /** * Deletes a detector. Deleting an anomaly detector will delete all of its corresponding resources including any configured datasets and alerts. */ deleteAnomalyDetector(params: LookoutMetrics.Types.DeleteAnomalyDetectorRequest, callback?: (err: AWSError, data: LookoutMetrics.Types.DeleteAnomalyDetectorResponse) => void): Request; /** * Deletes a detector. Deleting an anomaly detector will delete all of its corresponding resources including any configured datasets and alerts. */ deleteAnomalyDetector(callback?: (err: AWSError, data: LookoutMetrics.Types.DeleteAnomalyDetectorResponse) => void): Request; /** * 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. */ describeAlert(params: LookoutMetrics.Types.DescribeAlertRequest, callback?: (err: AWSError, data: LookoutMetrics.Types.DescribeAlertResponse) => void): Request; /** * 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. */ describeAlert(callback?: (err: AWSError, data: LookoutMetrics.Types.DescribeAlertResponse) => void): Request; /** * Returns information about the status of the specified anomaly detection jobs. */ describeAnomalyDetectionExecutions(params: LookoutMetrics.Types.DescribeAnomalyDetectionExecutionsRequest, callback?: (err: AWSError, data: LookoutMetrics.Types.DescribeAnomalyDetectionExecutionsResponse) => void): Request; /** * Returns information about the status of the specified anomaly detection jobs. */ describeAnomalyDetectionExecutions(callback?: (err: AWSError, data: LookoutMetrics.Types.DescribeAnomalyDetectionExecutionsResponse) => void): Request; /** * 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. */ describeAnomalyDetector(params: LookoutMetrics.Types.DescribeAnomalyDetectorRequest, callback?: (err: AWSError, data: LookoutMetrics.Types.DescribeAnomalyDetectorResponse) => void): Request; /** * 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. */ describeAnomalyDetector(callback?: (err: AWSError, data: LookoutMetrics.Types.DescribeAnomalyDetectorResponse) => void): Request; /** * 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. */ describeMetricSet(params: LookoutMetrics.Types.DescribeMetricSetRequest, callback?: (err: AWSError, data: LookoutMetrics.Types.DescribeMetricSetResponse) => void): Request; /** * 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. */ describeMetricSet(callback?: (err: AWSError, data: LookoutMetrics.Types.DescribeMetricSetResponse) => void): Request; /** * Returns details about a group of anomalous metrics. */ getAnomalyGroup(params: LookoutMetrics.Types.GetAnomalyGroupRequest, callback?: (err: AWSError, data: LookoutMetrics.Types.GetAnomalyGroupResponse) => void): Request; /** * Returns details about a group of anomalous metrics. */ getAnomalyGroup(callback?: (err: AWSError, data: LookoutMetrics.Types.GetAnomalyGroupResponse) => void): Request; /** * Get feedback for an anomaly group. */ getFeedback(params: LookoutMetrics.Types.GetFeedbackRequest, callback?: (err: AWSError, data: LookoutMetrics.Types.GetFeedbackResponse) => void): Request; /** * Get feedback for an anomaly group. */ getFeedback(callback?: (err: AWSError, data: LookoutMetrics.Types.GetFeedbackResponse) => void): Request; /** * Returns a selection of sample records from an Amazon S3 datasource. */ getSampleData(params: LookoutMetrics.Types.GetSampleDataRequest, callback?: (err: AWSError, data: LookoutMetrics.Types.GetSampleDataResponse) => void): Request; /** * Returns a selection of sample records from an Amazon S3 datasource. */ getSampleData(callback?: (err: AWSError, data: LookoutMetrics.Types.GetSampleDataResponse) => void): Request; /** * 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. */ listAlerts(params: LookoutMetrics.Types.ListAlertsRequest, callback?: (err: AWSError, data: LookoutMetrics.Types.ListAlertsResponse) => void): Request; /** * 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. */ listAlerts(callback?: (err: AWSError, data: LookoutMetrics.Types.ListAlertsResponse) => void): Request; /** * 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. */ listAnomalyDetectors(params: LookoutMetrics.Types.ListAnomalyDetectorsRequest, callback?: (err: AWSError, data: LookoutMetrics.Types.ListAnomalyDetectorsResponse) => void): Request; /** * 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. */ listAnomalyDetectors(callback?: (err: AWSError, data: LookoutMetrics.Types.ListAnomalyDetectorsResponse) => void): Request; /** * Returns a list of anomaly groups. */ listAnomalyGroupSummaries(params: LookoutMetrics.Types.ListAnomalyGroupSummariesRequest, callback?: (err: AWSError, data: LookoutMetrics.Types.ListAnomalyGroupSummariesResponse) => void): Request; /** * Returns a list of anomaly groups. */ listAnomalyGroupSummaries(callback?: (err: AWSError, data: LookoutMetrics.Types.ListAnomalyGroupSummariesResponse) => void): Request; /** * Gets a list of anomalous metrics for a measure in an anomaly group. */ listAnomalyGroupTimeSeries(params: LookoutMetrics.Types.ListAnomalyGroupTimeSeriesRequest, callback?: (err: AWSError, data: LookoutMetrics.Types.ListAnomalyGroupTimeSeriesResponse) => void): Request; /** * Gets a list of anomalous metrics for a measure in an anomaly group. */ listAnomalyGroupTimeSeries(callback?: (err: AWSError, data: LookoutMetrics.Types.ListAnomalyGroupTimeSeriesResponse) => void): Request; /** * 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. */ listMetricSets(params: LookoutMetrics.Types.ListMetricSetsRequest, callback?: (err: AWSError, data: LookoutMetrics.Types.ListMetricSetsResponse) => void): Request; /** * 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. */ listMetricSets(callback?: (err: AWSError, data: LookoutMetrics.Types.ListMetricSetsResponse) => void): Request; /** * Gets a list of tags for a detector, dataset, or alert. */ listTagsForResource(params: LookoutMetrics.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: LookoutMetrics.Types.ListTagsForResourceResponse) => void): Request; /** * Gets a list of tags for a detector, dataset, or alert. */ listTagsForResource(callback?: (err: AWSError, data: LookoutMetrics.Types.ListTagsForResourceResponse) => void): Request; /** * Add feedback for an anomalous metric. */ putFeedback(params: LookoutMetrics.Types.PutFeedbackRequest, callback?: (err: AWSError, data: LookoutMetrics.Types.PutFeedbackResponse) => void): Request; /** * Add feedback for an anomalous metric. */ putFeedback(callback?: (err: AWSError, data: LookoutMetrics.Types.PutFeedbackResponse) => void): Request; /** * Adds tags to a detector, dataset, or alert. */ tagResource(params: LookoutMetrics.Types.TagResourceRequest, callback?: (err: AWSError, data: LookoutMetrics.Types.TagResourceResponse) => void): Request; /** * Adds tags to a detector, dataset, or alert. */ tagResource(callback?: (err: AWSError, data: LookoutMetrics.Types.TagResourceResponse) => void): Request; /** * Removes tags from a detector, dataset, or alert. */ untagResource(params: LookoutMetrics.Types.UntagResourceRequest, callback?: (err: AWSError, data: LookoutMetrics.Types.UntagResourceResponse) => void): Request; /** * Removes tags from a detector, dataset, or alert. */ untagResource(callback?: (err: AWSError, data: LookoutMetrics.Types.UntagResourceResponse) => void): Request; /** * Updates a detector. After activation, you can only change a detector's ingestion delay and description. */ updateAnomalyDetector(params: LookoutMetrics.Types.UpdateAnomalyDetectorRequest, callback?: (err: AWSError, data: LookoutMetrics.Types.UpdateAnomalyDetectorResponse) => void): Request; /** * Updates a detector. After activation, you can only change a detector's ingestion delay and description. */ updateAnomalyDetector(callback?: (err: AWSError, data: LookoutMetrics.Types.UpdateAnomalyDetectorResponse) => void): Request; /** * Updates a dataset. */ updateMetricSet(params: LookoutMetrics.Types.UpdateMetricSetRequest, callback?: (err: AWSError, data: LookoutMetrics.Types.UpdateMetricSetResponse) => void): Request; /** * Updates a dataset. */ updateMetricSet(callback?: (err: AWSError, data: LookoutMetrics.Types.UpdateMetricSetResponse) => void): Request; } declare namespace LookoutMetrics { export interface Action { /** * A configuration for an Amazon SNS channel. */ SNSConfiguration?: SNSConfiguration; /** * A configuration for an AWS Lambda channel. */ LambdaConfiguration?: LambdaConfiguration; } export interface ActivateAnomalyDetectorRequest { /** * The ARN of the anomaly detector. */ AnomalyDetectorArn: Arn; } export interface ActivateAnomalyDetectorResponse { } export type AggregationFunction = "AVG"|"SUM"|string; export interface Alert { /** * Action that will be triggered when there is an alert. */ Action?: Action; /** * A description of the alert. */ AlertDescription?: AlertDescription; /** * The ARN of the alert. */ AlertArn?: Arn; /** * The ARN of the detector to which the alert is attached. */ AnomalyDetectorArn?: Arn; /** * The name of the alert. */ AlertName?: AlertName; /** * The minimum severity for an anomaly to trigger the alert. */ AlertSensitivityThreshold?: SensitivityThreshold; /** * The type of the alert. */ AlertType?: AlertType; /** * The status of the alert. */ AlertStatus?: AlertStatus; /** * The time at which the alert was last modified. */ LastModificationTime?: Timestamp; /** * The time at which the alert was created. */ CreationTime?: Timestamp; } export type AlertDescription = string; export type AlertName = string; export type AlertStatus = "ACTIVE"|"INACTIVE"|string; export interface AlertSummary { /** * The ARN of the alert. */ AlertArn?: Arn; /** * The ARN of the detector to which the alert is attached. */ AnomalyDetectorArn?: Arn; /** * The name of the alert. */ AlertName?: AlertName; /** * The minimum severity for an anomaly to trigger the alert. */ AlertSensitivityThreshold?: SensitivityThreshold; /** * The type of the alert. */ AlertType?: AlertType; /** * The status of the alert. */ AlertStatus?: AlertStatus; /** * The time at which the alert was last modified. */ LastModificationTime?: Timestamp; /** * The time at which the alert was created. */ CreationTime?: Timestamp; /** * The alert's tags. */ Tags?: TagMap; } export type AlertSummaryList = AlertSummary[]; export type AlertType = "SNS"|"LAMBDA"|string; export type AnomalyDetectionTaskStatus = "PENDING"|"IN_PROGRESS"|"COMPLETED"|"FAILED"|"FAILED_TO_SCHEDULE"|string; export type AnomalyDetectionTaskStatusMessage = string; export interface AnomalyDetectorConfig { /** * The frequency at which the detector analyzes its source data. */ AnomalyDetectorFrequency?: Frequency; } export interface AnomalyDetectorConfigSummary { /** * The interval at which the detector analyzes its source data. */ AnomalyDetectorFrequency?: Frequency; } export type AnomalyDetectorDescription = string; export type AnomalyDetectorName = string; export type AnomalyDetectorStatus = "ACTIVE"|"ACTIVATING"|"DELETING"|"FAILED"|"INACTIVE"|"LEARNING"|"BACK_TEST_ACTIVATING"|"BACK_TEST_ACTIVE"|"BACK_TEST_COMPLETE"|string; export interface AnomalyDetectorSummary { /** * The ARN of the detector. */ AnomalyDetectorArn?: Arn; /** * The name of the detector. */ AnomalyDetectorName?: AnomalyDetectorName; /** * A description of the detector. */ AnomalyDetectorDescription?: AnomalyDetectorDescription; /** * The time at which the detector was created. */ CreationTime?: Timestamp; /** * The time at which the detector was last modified. */ LastModificationTime?: Timestamp; /** * The status of detector. */ Status?: AnomalyDetectorStatus; /** * The detector's tags. */ Tags?: TagMap; } export type AnomalyDetectorSummaryList = AnomalyDetectorSummary[]; export interface AnomalyGroup { /** * The start time for the group. */ StartTime?: TimestampString; /** * The end time for the group. */ EndTime?: TimestampString; /** * The ID of the anomaly group. */ AnomalyGroupId?: UUID; /** * The severity score of the group. */ AnomalyGroupScore?: Score; /** * The name of the primary affected measure for the group. */ PrimaryMetricName?: MetricName; /** * A list of measures affected by the anomaly. */ MetricLevelImpactList?: MetricLevelImpactList; } export interface AnomalyGroupStatistics { /** * The start of the time range that was searched. */ EvaluationStartDate?: TimestampString; /** * The number of groups found. */ TotalCount?: Integer; /** * Statistics for individual metrics within the group. */ ItemizedMetricStatsList?: ItemizedMetricStatsList; } export interface AnomalyGroupSummary { /** * The start time for the group. */ StartTime?: TimestampString; /** * The end time for the group. */ EndTime?: TimestampString; /** * The ID of the anomaly group. */ AnomalyGroupId?: UUID; /** * The severity score of the group. */ AnomalyGroupScore?: Score; /** * The name of the primary affected measure for the group. */ PrimaryMetricName?: MetricName; } export type AnomalyGroupSummaryList = AnomalyGroupSummary[]; export interface AnomalyGroupTimeSeries { /** * The ID of the anomaly group. */ AnomalyGroupId: UUID; /** * The ID of the metric. */ TimeSeriesId?: TimeSeriesId; } export interface AnomalyGroupTimeSeriesFeedback { /** * The ID of the anomaly group. */ AnomalyGroupId: UUID; /** * The ID of the metric. */ TimeSeriesId: TimeSeriesId; /** * Feedback on whether the metric is a legitimate anomaly. */ IsAnomaly: Boolean; } export interface AppFlowConfig { /** * An IAM role that gives Amazon Lookout for Metrics permission to access the flow. */ RoleArn: Arn; /** * name of the flow. */ FlowName: FlowName; } export type Arn = string; export interface BackTestAnomalyDetectorRequest { /** * The Amazon Resource Name (ARN) of the anomaly detector. */ AnomalyDetectorArn: Arn; } export interface BackTestAnomalyDetectorResponse { } export type Boolean = boolean; export type CSVFileCompression = "NONE"|"GZIP"|string; export type Charset = string; export interface CloudWatchConfig { /** * An IAM role that gives Amazon Lookout for Metrics permission to access data in Amazon CloudWatch. */ RoleArn: Arn; } export type ColumnName = string; export interface ContributionMatrix { /** * A list of contributing dimensions. */ DimensionContributionList?: DimensionContributionList; } export interface CreateAlertRequest { /** * The name of the alert. */ AlertName: AlertName; /** * An integer from 0 to 100 specifying the alert sensitivity threshold. */ AlertSensitivityThreshold: SensitivityThreshold; /** * A description of the alert. */ AlertDescription?: AlertDescription; /** * The ARN of the detector to which the alert is attached. */ AnomalyDetectorArn: Arn; /** * Action that will be triggered when there is an alert. */ Action: Action; /** * A list of tags to apply to the alert. */ Tags?: TagMap; } export interface CreateAlertResponse { /** * The ARN of the alert. */ AlertArn?: Arn; } export interface CreateAnomalyDetectorRequest { /** * The name of the detector. */ AnomalyDetectorName: AnomalyDetectorName; /** * A description of the detector. */ AnomalyDetectorDescription?: AnomalyDetectorDescription; /** * Contains information about the configuration of the anomaly detector. */ AnomalyDetectorConfig: AnomalyDetectorConfig; /** * The ARN of the KMS key to use to encrypt your data. */ KmsKeyArn?: KmsKeyArn; /** * A list of tags to apply to the anomaly detector. */ Tags?: TagMap; } export interface CreateAnomalyDetectorResponse { /** * The ARN of the detector. */ AnomalyDetectorArn?: Arn; } export interface CreateMetricSetRequest { /** * The ARN of the anomaly detector that will use the dataset. */ AnomalyDetectorArn: Arn; /** * The name of the dataset. */ MetricSetName: MetricSetName; /** * A description of the dataset you are creating. */ MetricSetDescription?: MetricSetDescription; /** * A list of metrics that the dataset will contain. */ MetricList: MetricList; /** * After an interval ends, the amount of seconds that the detector waits before importing data. Offset is only supported for S3 and Redshift datasources. */ Offset?: Offset; /** * Contains information about the column used for tracking time in your source data. */ TimestampColumn?: TimestampColumn; /** * A list of the fields you want to treat as dimensions. */ DimensionList?: DimensionList; /** * The frequency with which the source data will be analyzed for anomalies. */ MetricSetFrequency?: Frequency; /** * Contains information about how the source data should be interpreted. */ MetricSource: MetricSource; /** * The time zone in which your source data was recorded. */ Timezone?: Timezone; /** * A list of tags to apply to the dataset. */ Tags?: TagMap; } export interface CreateMetricSetResponse { /** * The ARN of the dataset. */ MetricSetArn?: Arn; } export interface CsvFormatDescriptor { /** * The level of compression of the source CSV file. */ FileCompression?: CSVFileCompression; /** * The character set in which the source CSV file is written. */ Charset?: Charset; /** * Whether or not the source CSV file contains a header. */ ContainsHeader?: Boolean; /** * The character used to delimit the source CSV file. */ Delimiter?: Delimiter; /** * A list of the source CSV file's headers, if any. */ HeaderList?: HeaderList; /** * The character used as a quote character. */ QuoteSymbol?: QuoteSymbol; } export type DataItem = string; export type DatabaseHost = string; export type DatabasePort = number; export type DateTimeFormat = string; export interface DeleteAlertRequest { /** * The ARN of the alert to delete. */ AlertArn: Arn; } export interface DeleteAlertResponse { } export interface DeleteAnomalyDetectorRequest { /** * The ARN of the detector to delete. */ AnomalyDetectorArn: Arn; } export interface DeleteAnomalyDetectorResponse { } export type Delimiter = string; export interface DescribeAlertRequest { /** * The ARN of the alert to describe. */ AlertArn: Arn; } export interface DescribeAlertResponse { /** * Contains information about an alert. */ Alert?: Alert; } export interface DescribeAnomalyDetectionExecutionsRequest { /** * The Amazon Resource Name (ARN) of the anomaly detector. */ AnomalyDetectorArn: Arn; /** * The timestamp of the anomaly detection job. */ Timestamp?: TimestampString; /** * The number of items to return in the response. */ MaxResults?: MaxResults; /** * Specify the pagination token that's returned by a previous request to retrieve the next page of results. */ NextToken?: NextToken; } export interface DescribeAnomalyDetectionExecutionsResponse { /** * A list of detection jobs. */ ExecutionList?: ExecutionList; /** * The pagination token that's included if more results are available. */ NextToken?: NextToken; } export interface DescribeAnomalyDetectorRequest { /** * The ARN of the detector to describe. */ AnomalyDetectorArn: Arn; } export interface DescribeAnomalyDetectorResponse { /** * The ARN of the detector. */ AnomalyDetectorArn?: Arn; /** * The name of the detector. */ AnomalyDetectorName?: AnomalyDetectorName; /** * A description of the detector. */ AnomalyDetectorDescription?: AnomalyDetectorDescription; /** * Contains information about the detector's configuration. */ AnomalyDetectorConfig?: AnomalyDetectorConfigSummary; /** * The time at which the detector was created. */ CreationTime?: Timestamp; /** * The time at which the detector was last modified. */ LastModificationTime?: Timestamp; /** * The status of the detector. */ Status?: AnomalyDetectorStatus; /** * The reason that the detector failed, if any. */ FailureReason?: ErrorMessage; /** * The ARN of the KMS key to use to encrypt your data. */ KmsKeyArn?: KmsKeyArn; } export interface DescribeMetricSetRequest { /** * The ARN of the dataset. */ MetricSetArn: Arn; } export interface DescribeMetricSetResponse { /** * The ARN of the dataset. */ MetricSetArn?: Arn; /** * The ARN of the detector that contains the dataset. */ AnomalyDetectorArn?: Arn; /** * The name of the dataset. */ MetricSetName?: MetricSetName; /** * The dataset's description. */ MetricSetDescription?: MetricSetDescription; /** * The time at which the dataset was created. */ CreationTime?: Timestamp; /** * The time at which the dataset was last modified. */ LastModificationTime?: Timestamp; /** * The offset in seconds. Only supported for S3 and Redshift datasources. */ Offset?: Offset; /** * A list of the metrics defined by the dataset. */ MetricList?: MetricList; /** * Contains information about the column used for tracking time in your source data. */ TimestampColumn?: TimestampColumn; /** * A list of the dimensions chosen for analysis. */ DimensionList?: DimensionList; /** * The interval at which the data will be analyzed for anomalies. */ MetricSetFrequency?: Frequency; /** * The time zone in which the dataset's data was recorded. */ Timezone?: Timezone; /** * Contains information about the dataset's source data. */ MetricSource?: MetricSource; } export interface DimensionContribution { /** * The name of the dimension. */ DimensionName?: ColumnName; /** * A list of dimension values that contributed to the anomaly. */ DimensionValueContributionList?: DimensionValueContributionList; } export type DimensionContributionList = DimensionContribution[]; export type DimensionList = ColumnName[]; export interface DimensionNameValue { /** * The name of the dimension. */ DimensionName: ColumnName; /** * The value of the dimension. */ DimensionValue: DimensionValue; } export type DimensionNameValueList = DimensionNameValue[]; export type DimensionValue = string; export interface DimensionValueContribution { /** * The value of the dimension. */ DimensionValue?: DimensionValue; /** * The severity score of the value. */ ContributionScore?: Score; } export type DimensionValueContributionList = DimensionValueContribution[]; export type ErrorMessage = string; export type ExecutionList = ExecutionStatus[]; export interface ExecutionStatus { /** * The run's timestamp. */ Timestamp?: TimestampString; /** * The run's status. */ Status?: AnomalyDetectionTaskStatus; /** * The reason that the run failed, if applicable. */ FailureReason?: AnomalyDetectionTaskStatusMessage; } export interface FileFormatDescriptor { /** * Contains information about how a source CSV data file should be analyzed. */ CsvFormatDescriptor?: CsvFormatDescriptor; /** * Contains information about how a source JSON data file should be analyzed. */ JsonFormatDescriptor?: JsonFormatDescriptor; } export type FlowName = string; export type Frequency = "P1D"|"PT1H"|"PT10M"|"PT5M"|string; export interface GetAnomalyGroupRequest { /** * The ID of the anomaly group. */ AnomalyGroupId: UUID; /** * The Amazon Resource Name (ARN) of the anomaly detector. */ AnomalyDetectorArn: Arn; } export interface GetAnomalyGroupResponse { /** * Details about the anomaly group. */ AnomalyGroup?: AnomalyGroup; } export interface GetFeedbackRequest { /** * The Amazon Resource Name (ARN) of the anomaly detector. */ AnomalyDetectorArn: Arn; /** * The anomalous metric and group ID. */ AnomalyGroupTimeSeriesFeedback: AnomalyGroupTimeSeries; /** * The maximum number of results to return. */ MaxResults?: MaxResults; /** * Specify the pagination token that's returned by a previous request to retrieve the next page of results. */ NextToken?: NextToken; } export interface GetFeedbackResponse { /** * Feedback for an anomalous metric. */ AnomalyGroupTimeSeriesFeedback?: TimeSeriesFeedbackList; /** * The pagination token that's included if more results are available. */ NextToken?: NextToken; } export interface GetSampleDataRequest { /** * A datasource bucket in Amazon S3. */ S3SourceConfig?: SampleDataS3SourceConfig; } export interface GetSampleDataResponse { /** * A list of header labels for the records. */ HeaderValues?: HeaderValueList; /** * A list of records. */ SampleRows?: SampleRows; } export type HeaderList = ColumnName[]; export type HeaderValue = string; export type HeaderValueList = HeaderValue[]; export type HistoricalDataPath = string; export type HistoricalDataPathList = HistoricalDataPath[]; export type Integer = number; export interface ItemizedMetricStats { /** * The name of the measure. */ MetricName?: ColumnName; /** * The number of times that the measure appears. */ OccurrenceCount?: Integer; } export type ItemizedMetricStatsList = ItemizedMetricStats[]; export type JsonFileCompression = "NONE"|"GZIP"|string; export interface JsonFormatDescriptor { /** * The level of compression of the source CSV file. */ FileCompression?: JsonFileCompression; /** * The character set in which the source JSON file is written. */ Charset?: Charset; } export type KmsKeyArn = string; export interface LambdaConfiguration { /** * The ARN of an IAM role that has permission to invoke the Lambda function. */ RoleArn: Arn; /** * The ARN of the Lambda function. */ LambdaArn: Arn; } export interface ListAlertsRequest { /** * The ARN of the alert's detector. */ AnomalyDetectorArn?: Arn; /** * 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. */ NextToken?: NextToken; /** * The maximum number of results that will be displayed by the request. */ MaxResults?: MaxResults; } export interface ListAlertsResponse { /** * Contains information about an alert. */ AlertSummaryList?: AlertSummaryList; /** * If the response is truncated, the service returns this token. To retrieve the next set of results, use this token in the next request. */ NextToken?: NextToken; } export interface ListAnomalyDetectorsRequest { /** * The maximum number of results to return. */ MaxResults?: MaxResults; /** * 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. */ NextToken?: NextToken; } export interface ListAnomalyDetectorsResponse { /** * A list of anomaly detectors in the account in the current region. */ AnomalyDetectorSummaryList?: AnomalyDetectorSummaryList; /** * If the response is truncated, the service returns this token. To retrieve the next set of results, use the token in the next request. */ NextToken?: NextToken; } export interface ListAnomalyGroupSummariesRequest { /** * The Amazon Resource Name (ARN) of the anomaly detector. */ AnomalyDetectorArn: Arn; /** * The minimum severity score for inclusion in the output. */ SensitivityThreshold: SensitivityThreshold; /** * The maximum number of results to return. */ MaxResults?: MaxResults; /** * Specify the pagination token that's returned by a previous request to retrieve the next page of results. */ NextToken?: NextToken; } export interface ListAnomalyGroupSummariesResponse { /** * A list of anomaly group summaries. */ AnomalyGroupSummaryList?: AnomalyGroupSummaryList; /** * Aggregated details about the anomaly groups. */ AnomalyGroupStatistics?: AnomalyGroupStatistics; /** * The pagination token that's included if more results are available. */ NextToken?: NextToken; } export interface ListAnomalyGroupTimeSeriesRequest { /** * The Amazon Resource Name (ARN) of the anomaly detector. */ AnomalyDetectorArn: Arn; /** * The ID of the anomaly group. */ AnomalyGroupId: UUID; /** * The name of the measure field. */ MetricName: MetricName; /** * The maximum number of results to return. */ MaxResults?: MaxResults; /** * Specify the pagination token that's returned by a previous request to retrieve the next page of results. */ NextToken?: NextToken; } export interface ListAnomalyGroupTimeSeriesResponse { /** * The ID of the anomaly group. */ AnomalyGroupId?: UUID; /** * The name of the measure field. */ MetricName?: MetricName; /** * Timestamps for the anomalous metrics. */ TimestampList?: TimestampList; /** * The pagination token that's included if more results are available. */ NextToken?: NextToken; /** * A list of anomalous metrics. */ TimeSeriesList?: TimeSeriesList; } export interface ListMetricSetsRequest { /** * The ARN of the anomaly detector containing the metrics sets to list. */ AnomalyDetectorArn?: Arn; /** * The maximum number of results to return. */ MaxResults?: MaxResults; /** * 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. */ NextToken?: NextToken; } export interface ListMetricSetsResponse { /** * A list of the datasets in the AWS Region, with configuration details for each. */ MetricSetSummaryList?: MetricSetSummaryList; /** * 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. */ NextToken?: NextToken; } export interface ListTagsForResourceRequest { /** * The resource's Amazon Resource Name (ARN). */ ResourceArn: Arn; } export interface ListTagsForResourceResponse { /** * The resource's tags. */ Tags?: TagMap; } export type MaxResults = number; export interface Metric { /** * The name of the metric. */ MetricName: ColumnName; /** * The function with which the metric is calculated. */ AggregationFunction: AggregationFunction; /** * The namespace for the metric. */ Namespace?: Namespace; } export interface MetricLevelImpact { /** * The name of the measure. */ MetricName?: MetricName; /** * The number of anomalous metrics for the measure. */ NumTimeSeries?: Integer; /** * Details about the dimensions that contributed to the anomaly. */ ContributionMatrix?: ContributionMatrix; } export type MetricLevelImpactList = MetricLevelImpact[]; export type MetricList = Metric[]; export type MetricName = string; export type MetricSetDescription = string; export type MetricSetName = string; export interface MetricSetSummary { /** * The ARN of the dataset. */ MetricSetArn?: Arn; /** * The ARN of the detector to which the dataset belongs. */ AnomalyDetectorArn?: Arn; /** * The description of the dataset. */ MetricSetDescription?: MetricSetDescription; /** * The name of the dataset. */ MetricSetName?: MetricSetName; /** * The time at which the dataset was created. */ CreationTime?: Timestamp; /** * The time at which the dataset was last modified. */ LastModificationTime?: Timestamp; /** * The dataset's tags. */ Tags?: TagMap; } export type MetricSetSummaryList = MetricSetSummary[]; export interface MetricSource { S3SourceConfig?: S3SourceConfig; /** * An object containing information about the AppFlow configuration. */ AppFlowConfig?: AppFlowConfig; /** * An object containing information about the Amazon CloudWatch monitoring configuration. */ CloudWatchConfig?: CloudWatchConfig; /** * An object containing information about the Amazon Relational Database Service (RDS) configuration. */ RDSSourceConfig?: RDSSourceConfig; /** * An object containing information about the Amazon Redshift database configuration. */ RedshiftSourceConfig?: RedshiftSourceConfig; } export type MetricValue = number; export type MetricValueList = MetricValue[]; export type Namespace = string; export type NextToken = string; export type Offset = number; export type PoirotSecretManagerArn = string; export interface PutFeedbackRequest { /** * The Amazon Resource Name (ARN) of the anomaly detector. */ AnomalyDetectorArn: Arn; /** * Feedback for an anomalous metric. */ AnomalyGroupTimeSeriesFeedback: AnomalyGroupTimeSeriesFeedback; } export interface PutFeedbackResponse { } export type QuoteSymbol = string; export type RDSDatabaseIdentifier = string; export type RDSDatabaseName = string; export interface RDSSourceConfig { /** * A string identifying the database instance. */ DBInstanceIdentifier: RDSDatabaseIdentifier; /** * The host name of the database. */ DatabaseHost: DatabaseHost; /** * The port number where the database can be accessed. */ DatabasePort: DatabasePort; /** * The Amazon Resource Name (ARN) of the AWS Secrets Manager role. */ SecretManagerArn: PoirotSecretManagerArn; /** * The name of the RDS database. */ DatabaseName: RDSDatabaseName; /** * The name of the table in the database. */ TableName: TableName; /** * The Amazon Resource Name (ARN) of the role. */ RoleArn: Arn; /** * An object containing information about the Amazon Virtual Private Cloud (VPC) configuration. */ VpcConfiguration: VpcConfiguration; } export type RedshiftClusterIdentifier = string; export type RedshiftDatabaseName = string; export interface RedshiftSourceConfig { /** * A string identifying the Redshift cluster. */ ClusterIdentifier: RedshiftClusterIdentifier; /** * The name of the database host. */ DatabaseHost: DatabaseHost; /** * The port number where the database can be accessed. */ DatabasePort: DatabasePort; /** * The Amazon Resource Name (ARN) of the AWS Secrets Manager role. */ SecretManagerArn: PoirotSecretManagerArn; /** * The Redshift database name. */ DatabaseName: RedshiftDatabaseName; /** * The table name of the Redshift database. */ TableName: TableName; /** * The Amazon Resource Name (ARN) of the role providing access to the database. */ RoleArn: Arn; /** * Contains information about the Amazon Virtual Private Cloud (VPC) configuration. */ VpcConfiguration: VpcConfiguration; } export interface S3SourceConfig { /** * The ARN of an IAM role that has read and write access permissions to the source S3 bucket. */ RoleArn: Arn; /** * A list of templated paths to the source files. */ TemplatedPathList?: TemplatedPathList; /** * A list of paths to the historical data files. */ HistoricalDataPathList?: HistoricalDataPathList; /** * Contains information about a source file's formatting. */ FileFormatDescriptor?: FileFormatDescriptor; } export interface SNSConfiguration { /** * The ARN of the IAM role that has access to the target SNS topic. */ RoleArn: Arn; /** * The ARN of the target SNS topic. */ SnsTopicArn: Arn; } export interface SampleDataS3SourceConfig { /** * The Amazon Resource Name (ARN) of the role. */ RoleArn: Arn; /** * An array of strings containing the list of templated paths. */ TemplatedPathList?: TemplatedPathList; /** * An array of strings containing the historical set of data paths. */ HistoricalDataPathList?: HistoricalDataPathList; FileFormatDescriptor: FileFormatDescriptor; } export type SampleRow = DataItem[]; export type SampleRows = SampleRow[]; export type Score = number; export type SecurityGroupId = string; export type SecurityGroupIdList = SecurityGroupId[]; export type SensitivityThreshold = number; export type SubnetId = string; export type SubnetIdList = SubnetId[]; export type TableName = string; export type TagKey = string; export type TagKeyList = TagKey[]; export type TagMap = {[key: string]: TagValue}; export interface TagResourceRequest { /** * The resource's Amazon Resource Name (ARN). */ ResourceArn: Arn; /** * Tags to apply to the resource. Tag keys and values can contain letters, numbers, spaces, and the following symbols: _.:/=+@- */ Tags: TagMap; } export interface TagResourceResponse { } export type TagValue = string; export type TemplatedPath = string; export type TemplatedPathList = TemplatedPath[]; export interface TimeSeries { /** * The ID of the metric. */ TimeSeriesId: TimeSeriesId; /** * The dimensions of the metric. */ DimensionList: DimensionNameValueList; /** * The values for the metric. */ MetricValueList: MetricValueList; } export interface TimeSeriesFeedback { /** * The ID of the metric. */ TimeSeriesId?: TimeSeriesId; /** * Feedback on whether the metric is a legitimate anomaly. */ IsAnomaly?: Boolean; } export type TimeSeriesFeedbackList = TimeSeriesFeedback[]; export type TimeSeriesId = string; export type TimeSeriesList = TimeSeries[]; export type Timestamp = Date; export interface TimestampColumn { /** * The name of the timestamp column. */ ColumnName?: ColumnName; /** * The format of the timestamp column. */ ColumnFormat?: DateTimeFormat; } export type TimestampList = TimestampString[]; export type TimestampString = string; export type Timezone = string; export type UUID = string; export interface UntagResourceRequest { /** * The resource's Amazon Resource Name (ARN). */ ResourceArn: Arn; /** * Keys to remove from the resource's tags. */ TagKeys: TagKeyList; } export interface UntagResourceResponse { } export interface UpdateAnomalyDetectorRequest { /** * The ARN of the detector to update. */ AnomalyDetectorArn: Arn; /** * The Amazon Resource Name (ARN) of an AWS KMS encryption key. */ KmsKeyArn?: KmsKeyArn; /** * The updated detector description. */ AnomalyDetectorDescription?: AnomalyDetectorDescription; /** * Contains information about the configuration to which the detector will be updated. */ AnomalyDetectorConfig?: AnomalyDetectorConfig; } export interface UpdateAnomalyDetectorResponse { /** * The ARN of the updated detector. */ AnomalyDetectorArn?: Arn; } export interface UpdateMetricSetRequest { /** * The ARN of the dataset to update. */ MetricSetArn: Arn; /** * The dataset's description. */ MetricSetDescription?: MetricSetDescription; /** * The metric list. */ MetricList?: MetricList; /** * After an interval ends, the amount of seconds that the detector waits before importing data. Offset is only supported for S3 and Redshift datasources. */ Offset?: Offset; /** * The timestamp column. */ TimestampColumn?: TimestampColumn; /** * The dimension list. */ DimensionList?: DimensionList; /** * The dataset's interval. */ MetricSetFrequency?: Frequency; MetricSource?: MetricSource; } export interface UpdateMetricSetResponse { /** * The ARN of the dataset. */ MetricSetArn?: Arn; } export interface VpcConfiguration { /** * An array of strings containing the Amazon VPC subnet IDs (e.g., subnet-0bb1c79de3EXAMPLE. */ SubnetIdList: SubnetIdList; /** * An array of strings containing the list of security groups. */ SecurityGroupIdList: SecurityGroupIdList; } /** * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. */ export type apiVersion = "2017-07-25"|"latest"|string; export interface ClientApiVersions { /** * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. */ apiVersion?: apiVersion; } export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; /** * Contains interfaces for use with the LookoutMetrics client. */ export import Types = LookoutMetrics; } export = LookoutMetrics;