2021/03/25 - Amazon Lookout for Metrics - 25 new api methods
Changes Amazon Lookout for Metrics is now generally available. You can use Lookout for Metrics to monitor your data for anomalies. For more information, see the Amazon Lookout for Metrics Developer Guide.
Describes an alert.
See also: AWS API Documentation
Request Syntax
client.describe_alert(
AlertArn='string'
)
string
[REQUIRED]
The ARN of the alert to describe.
dict
Response Syntax
{
'Alert': {
'Action': {
'SNSConfiguration': {
'RoleArn': 'string',
'SnsTopicArn': 'string'
},
'LambdaConfiguration': {
'RoleArn': 'string',
'LambdaArn': 'string'
}
},
'AlertDescription': 'string',
'AlertArn': 'string',
'AnomalyDetectorArn': 'string',
'AlertName': 'string',
'AlertSensitivityThreshold': 123,
'AlertType': 'SNS'|'LAMBDA',
'AlertStatus': 'ACTIVE'|'INACTIVE',
'LastModificationTime': datetime(2015, 1, 1),
'CreationTime': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
Alert (dict) --
Contains information about an alert.
Action (dict) --
Action that will be triggered when there is an alert.
SNSConfiguration (dict) --
A configuration for an Amazon SNS channel.
RoleArn (string) --
THe ARN of the IAM role that has access to the target SNS topic.
SnsTopicArn (string) --
The ARN of the target SNS topic.
LambdaConfiguration (dict) --
A configuration for an AWS Lambda channel.
RoleArn (string) --
The ARN of an IAM role that has permission to invoke the Lambda function.
LambdaArn (string) --
The ARN of the Lambda function.
AlertDescription (string) --
A description of the alert.
AlertArn (string) --
The ARN of the alert.
AnomalyDetectorArn (string) --
The ARN of the detector to which the alert is attached.
AlertName (string) --
The name of the alert.
AlertSensitivityThreshold (integer) --
The minimum severity for an anomaly to trigger the alert.
AlertType (string) --
The type of the alert.
AlertStatus (string) --
The status of the alert.
LastModificationTime (datetime) --
The time at which the alert was last modified.
CreationTime (datetime) --
The time at which the alert was created.
Updates a dataset.
See also: AWS API Documentation
Request Syntax
client.update_metric_set(
MetricSetArn='string',
MetricSetDescription='string',
MetricList=[
{
'MetricName': 'string',
'AggregationFunction': 'AVG'|'SUM',
'Namespace': 'string'
},
],
Offset=123,
TimestampColumn={
'ColumnName': 'string',
'ColumnFormat': 'string'
},
DimensionList=[
'string',
],
MetricSetFrequency='P1D'|'PT1H'|'PT10M'|'PT5M',
MetricSource={
'S3SourceConfig': {
'RoleArn': 'string',
'TemplatedPathList': [
'string',
],
'HistoricalDataPathList': [
'string',
],
'FileFormatDescriptor': {
'CsvFormatDescriptor': {
'FileCompression': 'NONE'|'GZIP',
'Charset': 'string',
'ContainsHeader': True|False,
'Delimiter': 'string',
'HeaderList': [
'string',
],
'QuoteSymbol': 'string'
},
'JsonFormatDescriptor': {
'FileCompression': 'NONE'|'GZIP',
'Charset': 'string'
}
}
},
'AppFlowConfig': {
'RoleArn': 'string',
'FlowName': 'string'
},
'CloudWatchConfig': {
'RoleArn': 'string'
},
'RDSSourceConfig': {
'DBInstanceIdentifier': 'string',
'DatabaseHost': 'string',
'DatabasePort': 123,
'SecretManagerArn': 'string',
'DatabaseName': 'string',
'TableName': 'string',
'RoleArn': 'string',
'VpcConfiguration': {
'SubnetIdList': [
'string',
],
'SecurityGroupIdList': [
'string',
]
}
},
'RedshiftSourceConfig': {
'ClusterIdentifier': 'string',
'DatabaseHost': 'string',
'DatabasePort': 123,
'SecretManagerArn': 'string',
'DatabaseName': 'string',
'TableName': 'string',
'RoleArn': 'string',
'VpcConfiguration': {
'SubnetIdList': [
'string',
],
'SecurityGroupIdList': [
'string',
]
}
}
}
)
string
[REQUIRED]
The ARN of the dataset to update.
string
The dataset's description.
list
The metric list.
(dict) --
A calculation made by contrasting a measure and a dimension from your source data.
MetricName (string) -- [REQUIRED]
The name of the metric.
AggregationFunction (string) -- [REQUIRED]
The function with which the metric is calculated.
Namespace (string) --
The namespace for the metric.
integer
After an interval ends, the amount of time that the detector waits before importing data.
dict
The timestamp column.
ColumnName (string) --
The name of the timestamp column.
ColumnFormat (string) --
The format of the timestamp column.
list
The dimension list.
(string) --
string
The dataset's interval.
dict
Contains information about source data used to generate a metric.
S3SourceConfig (dict) --
Contains information about the configuration of the S3 bucket that contains source files.
RoleArn (string) -- [REQUIRED]
The ARN of an IAM role that has read and write access permissions to the source S3 bucket.
TemplatedPathList (list) --
A list of templated paths to the source files.
(string) --
HistoricalDataPathList (list) --
A list of paths to the historical data files.
(string) --
FileFormatDescriptor (dict) --
Contains information about a source file's formatting.
CsvFormatDescriptor (dict) --
Contains information about how a source CSV data file should be analyzed.
FileCompression (string) --
The level of compression of the source CSV file.
Charset (string) --
The character set in which the source CSV file is written.
ContainsHeader (boolean) --
Whether or not the source CSV file contains a header.
Delimiter (string) --
The character used to delimit the source CSV file.
HeaderList (list) --
A list of the source CSV file's headers, if any.
(string) --
QuoteSymbol (string) --
The character used as a quote character.
JsonFormatDescriptor (dict) --
Contains information about how a source JSON data file should be analyzed.
FileCompression (string) --
The level of compression of the source CSV file.
Charset (string) --
The character set in which the source JSON file is written.
AppFlowConfig (dict) --
An object containing information about the AppFlow configuration.
RoleArn (string) -- [REQUIRED]
An IAM role that gives Amazon Lookout for Metrics permission to access the flow.
FlowName (string) -- [REQUIRED]
The name of the flow.
CloudWatchConfig (dict) --
An object containing information about the Amazon CloudWatch monitoring configuration.
RoleArn (string) -- [REQUIRED]
An IAM role that gives Amazon Lookout for Metrics permission to access data in Amazon CloudWatch.
RDSSourceConfig (dict) --
An object containing information about the Amazon Relational Database Service (RDS) configuration.
DBInstanceIdentifier (string) -- [REQUIRED]
A string identifying the database instance.
DatabaseHost (string) -- [REQUIRED]
The host name of the database.
DatabasePort (integer) -- [REQUIRED]
The port number where the database can be accessed.
SecretManagerArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the AWS Secrets Manager role.
DatabaseName (string) -- [REQUIRED]
The name of the RDS database.
TableName (string) -- [REQUIRED]
The name of the table in the database.
RoleArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the role.
VpcConfiguration (dict) -- [REQUIRED]
An object containing information about the Amazon Virtual Private Cloud (VPC) configuration.
SubnetIdList (list) -- [REQUIRED]
An array of strings containing the Amazon VPC subnet IDs (e.g., subnet-0bb1c79de3EXAMPLE .
(string) --
SecurityGroupIdList (list) -- [REQUIRED]
An array of strings containing the list of security groups.
(string) --
RedshiftSourceConfig (dict) --
An object containing information about the Amazon Redshift database configuration.
ClusterIdentifier (string) -- [REQUIRED]
A string identifying the Redshift cluster.
DatabaseHost (string) -- [REQUIRED]
The name of the database host.
DatabasePort (integer) -- [REQUIRED]
The port number where the database can be accessed.
SecretManagerArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the AWS Secrets Manager role.
DatabaseName (string) -- [REQUIRED]
The Redshift database name.
TableName (string) -- [REQUIRED]
The table name of the Redshift database.
RoleArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the role providing access to the database.
VpcConfiguration (dict) -- [REQUIRED]
Contains information about the Amazon Virtual Private Cloud (VPC) configuration.
SubnetIdList (list) -- [REQUIRED]
An array of strings containing the Amazon VPC subnet IDs (e.g., subnet-0bb1c79de3EXAMPLE .
(string) --
SecurityGroupIdList (list) -- [REQUIRED]
An array of strings containing the list of security groups.
(string) --
dict
Response Syntax
{
'MetricSetArn': 'string'
}
Response Structure
(dict) --
MetricSetArn (string) --
The ARN of the dataset.
Creates a dataset.
See also: AWS API Documentation
Request Syntax
client.create_metric_set(
AnomalyDetectorArn='string',
MetricSetName='string',
MetricSetDescription='string',
MetricList=[
{
'MetricName': 'string',
'AggregationFunction': 'AVG'|'SUM',
'Namespace': 'string'
},
],
Offset=123,
TimestampColumn={
'ColumnName': 'string',
'ColumnFormat': 'string'
},
DimensionList=[
'string',
],
MetricSetFrequency='P1D'|'PT1H'|'PT10M'|'PT5M',
MetricSource={
'S3SourceConfig': {
'RoleArn': 'string',
'TemplatedPathList': [
'string',
],
'HistoricalDataPathList': [
'string',
],
'FileFormatDescriptor': {
'CsvFormatDescriptor': {
'FileCompression': 'NONE'|'GZIP',
'Charset': 'string',
'ContainsHeader': True|False,
'Delimiter': 'string',
'HeaderList': [
'string',
],
'QuoteSymbol': 'string'
},
'JsonFormatDescriptor': {
'FileCompression': 'NONE'|'GZIP',
'Charset': 'string'
}
}
},
'AppFlowConfig': {
'RoleArn': 'string',
'FlowName': 'string'
},
'CloudWatchConfig': {
'RoleArn': 'string'
},
'RDSSourceConfig': {
'DBInstanceIdentifier': 'string',
'DatabaseHost': 'string',
'DatabasePort': 123,
'SecretManagerArn': 'string',
'DatabaseName': 'string',
'TableName': 'string',
'RoleArn': 'string',
'VpcConfiguration': {
'SubnetIdList': [
'string',
],
'SecurityGroupIdList': [
'string',
]
}
},
'RedshiftSourceConfig': {
'ClusterIdentifier': 'string',
'DatabaseHost': 'string',
'DatabasePort': 123,
'SecretManagerArn': 'string',
'DatabaseName': 'string',
'TableName': 'string',
'RoleArn': 'string',
'VpcConfiguration': {
'SubnetIdList': [
'string',
],
'SecurityGroupIdList': [
'string',
]
}
}
},
Timezone='string',
Tags={
'string': 'string'
}
)
string
[REQUIRED]
The ARN of the anomaly detector that will use the dataset.
string
[REQUIRED]
The name of the dataset.
string
A description of the dataset you are creating.
list
[REQUIRED]
A list of metrics that the dataset will contain.
(dict) --
A calculation made by contrasting a measure and a dimension from your source data.
MetricName (string) -- [REQUIRED]
The name of the metric.
AggregationFunction (string) -- [REQUIRED]
The function with which the metric is calculated.
Namespace (string) --
The namespace for the metric.
integer
After an interval ends, the amount of time that the detector waits before importing data.
dict
Contains information about the column used for tracking time in your source data.
ColumnName (string) --
The name of the timestamp column.
ColumnFormat (string) --
The format of the timestamp column.
list
A list of the fields you want to treat as dimensions.
(string) --
string
The frequency with which the source data will be analyzed for anomalies.
dict
[REQUIRED]
Contains information about how the source data should be interpreted.
S3SourceConfig (dict) --
Contains information about the configuration of the S3 bucket that contains source files.
RoleArn (string) -- [REQUIRED]
The ARN of an IAM role that has read and write access permissions to the source S3 bucket.
TemplatedPathList (list) --
A list of templated paths to the source files.
(string) --
HistoricalDataPathList (list) --
A list of paths to the historical data files.
(string) --
FileFormatDescriptor (dict) --
Contains information about a source file's formatting.
CsvFormatDescriptor (dict) --
Contains information about how a source CSV data file should be analyzed.
FileCompression (string) --
The level of compression of the source CSV file.
Charset (string) --
The character set in which the source CSV file is written.
ContainsHeader (boolean) --
Whether or not the source CSV file contains a header.
Delimiter (string) --
The character used to delimit the source CSV file.
HeaderList (list) --
A list of the source CSV file's headers, if any.
(string) --
QuoteSymbol (string) --
The character used as a quote character.
JsonFormatDescriptor (dict) --
Contains information about how a source JSON data file should be analyzed.
FileCompression (string) --
The level of compression of the source CSV file.
Charset (string) --
The character set in which the source JSON file is written.
AppFlowConfig (dict) --
An object containing information about the AppFlow configuration.
RoleArn (string) -- [REQUIRED]
An IAM role that gives Amazon Lookout for Metrics permission to access the flow.
FlowName (string) -- [REQUIRED]
The name of the flow.
CloudWatchConfig (dict) --
An object containing information about the Amazon CloudWatch monitoring configuration.
RoleArn (string) -- [REQUIRED]
An IAM role that gives Amazon Lookout for Metrics permission to access data in Amazon CloudWatch.
RDSSourceConfig (dict) --
An object containing information about the Amazon Relational Database Service (RDS) configuration.
DBInstanceIdentifier (string) -- [REQUIRED]
A string identifying the database instance.
DatabaseHost (string) -- [REQUIRED]
The host name of the database.
DatabasePort (integer) -- [REQUIRED]
The port number where the database can be accessed.
SecretManagerArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the AWS Secrets Manager role.
DatabaseName (string) -- [REQUIRED]
The name of the RDS database.
TableName (string) -- [REQUIRED]
The name of the table in the database.
RoleArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the role.
VpcConfiguration (dict) -- [REQUIRED]
An object containing information about the Amazon Virtual Private Cloud (VPC) configuration.
SubnetIdList (list) -- [REQUIRED]
An array of strings containing the Amazon VPC subnet IDs (e.g., subnet-0bb1c79de3EXAMPLE .
(string) --
SecurityGroupIdList (list) -- [REQUIRED]
An array of strings containing the list of security groups.
(string) --
RedshiftSourceConfig (dict) --
An object containing information about the Amazon Redshift database configuration.
ClusterIdentifier (string) -- [REQUIRED]
A string identifying the Redshift cluster.
DatabaseHost (string) -- [REQUIRED]
The name of the database host.
DatabasePort (integer) -- [REQUIRED]
The port number where the database can be accessed.
SecretManagerArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the AWS Secrets Manager role.
DatabaseName (string) -- [REQUIRED]
The Redshift database name.
TableName (string) -- [REQUIRED]
The table name of the Redshift database.
RoleArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the role providing access to the database.
VpcConfiguration (dict) -- [REQUIRED]
Contains information about the Amazon Virtual Private Cloud (VPC) configuration.
SubnetIdList (list) -- [REQUIRED]
An array of strings containing the Amazon VPC subnet IDs (e.g., subnet-0bb1c79de3EXAMPLE .
(string) --
SecurityGroupIdList (list) -- [REQUIRED]
An array of strings containing the list of security groups.
(string) --
string
The time zone in which your source data was recorded.
dict
A list of tags to apply to the dataset.
(string) --
(string) --
dict
Response Syntax
{
'MetricSetArn': 'string'
}
Response Structure
(dict) --
MetricSetArn (string) --
The ARN of the dataset.
Describes a detector.
See also: AWS API Documentation
Request Syntax
client.describe_anomaly_detector(
AnomalyDetectorArn='string'
)
string
[REQUIRED]
The ARN of the detector to describe.
dict
Response Syntax
{
'AnomalyDetectorArn': 'string',
'AnomalyDetectorName': 'string',
'AnomalyDetectorDescription': 'string',
'AnomalyDetectorConfig': {
'AnomalyDetectorFrequency': 'P1D'|'PT1H'|'PT10M'|'PT5M'
},
'CreationTime': datetime(2015, 1, 1),
'LastModificationTime': datetime(2015, 1, 1),
'Status': 'ACTIVE'|'ACTIVATING'|'DELETING'|'FAILED'|'INACTIVE'|'BACK_TEST_ACTIVATING'|'BACK_TEST_ACTIVE'|'BACK_TEST_COMPLETE',
'FailureReason': 'string',
'KmsKeyArn': 'string'
}
Response Structure
(dict) --
AnomalyDetectorArn (string) --
The ARN of the detector.
AnomalyDetectorName (string) --
The name of the detector.
AnomalyDetectorDescription (string) --
A description of the detector.
AnomalyDetectorConfig (dict) --
Contains information about the detector's configuration.
AnomalyDetectorFrequency (string) --
The interval at which the detector analyzes its source data.
CreationTime (datetime) --
The time at which the detector was created.
LastModificationTime (datetime) --
The time at which the detector was last modified.
Status (string) --
The status of the detector.
FailureReason (string) --
The reason that the detector failed, if any.
KmsKeyArn (string) --
The ARN of the KMS key to use to encrypt your data.
Updates a detector. After activation, you can only change a detector's ingestion delay and description.
See also: AWS API Documentation
Request Syntax
client.update_anomaly_detector(
AnomalyDetectorArn='string',
KmsKeyArn='string',
AnomalyDetectorDescription='string',
AnomalyDetectorConfig={
'AnomalyDetectorFrequency': 'P1D'|'PT1H'|'PT10M'|'PT5M'
}
)
string
[REQUIRED]
The ARN of the detector to update.
string
The Amazon Resource Name (ARN) of an AWS KMS encryption key.
string
The updated detector description.
dict
Contains information about the configuration to which the detector will be updated.
AnomalyDetectorFrequency (string) --
The frequency at which the detector analyzes its source data.
dict
Response Syntax
{
'AnomalyDetectorArn': 'string'
}
Response Structure
(dict) --
AnomalyDetectorArn (string) --
The ARN of the updated detector.
Removes tags from a detector, dataset, or alert.
See also: AWS API Documentation
Request Syntax
client.untag_resource(
ResourceArn='string',
TagKeys=[
'string',
]
)
string
[REQUIRED]
The resource's Amazon Resource Name (ARN).
list
[REQUIRED]
Keys to remove from the resource's tags.
(string) --
dict
Response Syntax
{}
Response Structure
(dict) --
Lists the alerts attached to a detector.
See also: AWS API Documentation
Request Syntax
client.list_alerts(
AnomalyDetectorArn='string',
NextToken='string',
MaxResults=123
)
string
The ARN of the alert's detector.
string
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.
integer
The maximum number of results that will be displayed by the request.
dict
Response Syntax
{
'AlertSummaryList': [
{
'AlertArn': 'string',
'AnomalyDetectorArn': 'string',
'AlertName': 'string',
'AlertSensitivityThreshold': 123,
'AlertType': 'SNS'|'LAMBDA',
'AlertStatus': 'ACTIVE'|'INACTIVE',
'LastModificationTime': datetime(2015, 1, 1),
'CreationTime': datetime(2015, 1, 1),
'Tags': {
'string': 'string'
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
AlertSummaryList (list) --
Contains information about an alert.
(dict) --
Provides a summary of an alert's configuration.
AlertArn (string) --
The ARN of the alert.
AnomalyDetectorArn (string) --
The ARN of the detector to which the alert is attached.
AlertName (string) --
The name of the alert.
AlertSensitivityThreshold (integer) --
The minimum severity for an anomaly to trigger the alert.
AlertType (string) --
The type of the alert.
AlertStatus (string) --
The status of the alert.
LastModificationTime (datetime) --
The time at which the alert was last modified.
CreationTime (datetime) --
The time at which the alert was created.
Tags (dict) --
The alert's tags .
(string) --
(string) --
NextToken (string) --
If the response is truncated, the service returns this token. To retrieve the next set of results, use this token in the next request.
Adds tags to a detector, dataset, or alert.
See also: AWS API Documentation
Request Syntax
client.tag_resource(
ResourceArn='string',
Tags={
'string': 'string'
}
)
string
[REQUIRED]
The resource's Amazon Resource Name (ARN).
dict
[REQUIRED]
Tags to apply to the resource. Tag keys and values can contain letters, numbers, spaces, and the following symbols: _.:/=+@-
(string) --
(string) --
dict
Response Syntax
{}
Response Structure
(dict) --
Returns a list of anomaly groups.
See also: AWS API Documentation
Request Syntax
client.list_anomaly_group_summaries(
AnomalyDetectorArn='string',
SensitivityThreshold=123,
MaxResults=123,
NextToken='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the anomaly detector.
integer
[REQUIRED]
The minimum severity score for inclusion in the output.
integer
The maximum number of results to return.
string
Specify the pagination token that's returned by a previous request to retrieve the next page of results.
dict
Response Syntax
{
'AnomalyGroupSummaryList': [
{
'StartTime': 'string',
'EndTime': 'string',
'AnomalyGroupId': 'string',
'AnomalyGroupScore': 123.0,
'PrimaryMetricName': 'string'
},
],
'AnomalyGroupStatistics': {
'EvaluationStartDate': 'string',
'TotalCount': 123,
'ItemizedMetricStatsList': [
{
'MetricName': 'string',
'OccurrenceCount': 123
},
]
},
'NextToken': 'string'
}
Response Structure
(dict) --
AnomalyGroupSummaryList (list) --
A list of anomaly group summaries.
(dict) --
Details about a group of anomalous metrics.
StartTime (string) --
The start time for the group.
EndTime (string) --
The end time for the group.
AnomalyGroupId (string) --
The ID of the anomaly group.
AnomalyGroupScore (float) --
The severity score of the group.
PrimaryMetricName (string) --
The name of the primary affected measure for the group.
AnomalyGroupStatistics (dict) --
Aggregated details about the anomaly groups.
EvaluationStartDate (string) --
The start of the time range that was searched.
TotalCount (integer) --
The number of groups found.
ItemizedMetricStatsList (list) --
Statistics for individual metrics within the group.
(dict) --
Aggregated statistics about a measure affected by an anomaly.
MetricName (string) --
The name of the measure.
OccurrenceCount (integer) --
The number of times that the measure appears.
NextToken (string) --
The pagination token that's included if more results are available.
Get feedback for an anomaly group.
See also: AWS API Documentation
Request Syntax
client.get_feedback(
AnomalyDetectorArn='string',
AnomalyGroupTimeSeriesFeedback={
'AnomalyGroupId': 'string',
'TimeSeriesId': 'string'
},
MaxResults=123,
NextToken='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the anomaly detector.
dict
[REQUIRED]
The anomalous metric and group ID.
AnomalyGroupId (string) -- [REQUIRED]
The ID of the anomaly group.
TimeSeriesId (string) --
The ID of the metric.
integer
The maximum number of results to return.
string
Specify the pagination token that's returned by a previous request to retrieve the next page of results.
dict
Response Syntax
{
'AnomalyGroupTimeSeriesFeedback': [
{
'TimeSeriesId': 'string',
'IsAnomaly': True|False
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
AnomalyGroupTimeSeriesFeedback (list) --
Feedback for an anomalous metric.
(dict) --
Details about feedback submitted for an anomalous metric.
TimeSeriesId (string) --
The ID of the metric.
IsAnomaly (boolean) --
Feedback on whether the metric is a legitimate anomaly.
NextToken (string) --
The pagination token that's included if more results are available.
Activates an anomaly detector.
See also: AWS API Documentation
Request Syntax
client.activate_anomaly_detector(
AnomalyDetectorArn='string'
)
string
[REQUIRED]
The ARN of the anomaly detector.
dict
Response Syntax
{}
Response Structure
(dict) --
Returns details about a group of anomalous metrics.
See also: AWS API Documentation
Request Syntax
client.get_anomaly_group(
AnomalyGroupId='string',
AnomalyDetectorArn='string'
)
string
[REQUIRED]
The ID of the anomaly group.
string
[REQUIRED]
The Amazon Resource Name (ARN) of the anomaly detector.
dict
Response Syntax
{
'AnomalyGroup': {
'StartTime': 'string',
'EndTime': 'string',
'AnomalyGroupId': 'string',
'AnomalyGroupScore': 123.0,
'PrimaryMetricName': 'string',
'MetricLevelImpactList': [
{
'MetricName': 'string',
'NumTimeSeries': 123,
'ContributionMatrix': {
'DimensionContributionList': [
{
'DimensionName': 'string',
'DimensionValueContributionList': [
{
'DimensionValue': 'string',
'ContributionScore': 123.0
},
]
},
]
}
},
]
}
}
Response Structure
(dict) --
AnomalyGroup (dict) --
Details about the anomaly group.
StartTime (string) --
The start time for the group.
EndTime (string) --
The end time for the group.
AnomalyGroupId (string) --
The ID of the anomaly group.
AnomalyGroupScore (float) --
The severity score of the group.
PrimaryMetricName (string) --
The name of the primary affected measure for the group.
MetricLevelImpactList (list) --
A list of measures affected by the anomaly.
(dict) --
Details about a measure affected by an anomaly.
MetricName (string) --
The name of the measure.
NumTimeSeries (integer) --
The number of anomalous metrics for the measure.
ContributionMatrix (dict) --
Details about the dimensions that contributed to the anomaly.
DimensionContributionList (list) --
A list of contributing dimensions.
(dict) --
Details about a dimension that contributed to an anomaly.
DimensionName (string) --
The name of the dimension.
DimensionValueContributionList (list) --
A list of dimension values that contributed to the anomaly.
(dict) --
The severity of a value of a dimension that contributed to an anomaly.
DimensionValue (string) --
The value of the dimension.
ContributionScore (float) --
The severity score of the value.
Lists the detectors in the current AWS Region.
See also: AWS API Documentation
Request Syntax
client.list_anomaly_detectors(
MaxResults=123,
NextToken='string'
)
integer
The maximum number of results to return.
string
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.
dict
Response Syntax
{
'AnomalyDetectorSummaryList': [
{
'AnomalyDetectorArn': 'string',
'AnomalyDetectorName': 'string',
'AnomalyDetectorDescription': 'string',
'CreationTime': datetime(2015, 1, 1),
'LastModificationTime': datetime(2015, 1, 1),
'Status': 'ACTIVE'|'ACTIVATING'|'DELETING'|'FAILED'|'INACTIVE'|'BACK_TEST_ACTIVATING'|'BACK_TEST_ACTIVE'|'BACK_TEST_COMPLETE',
'Tags': {
'string': 'string'
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
AnomalyDetectorSummaryList (list) --
A list of anomaly detectors in the account in the current region.
(dict) --
Contains information about an an anomaly detector.
AnomalyDetectorArn (string) --
The ARN of the detector.
AnomalyDetectorName (string) --
The name of the detector.
AnomalyDetectorDescription (string) --
A description of the detector.
CreationTime (datetime) --
The time at which the detector was created.
LastModificationTime (datetime) --
The time at which the detector was last modified.
Status (string) --
The status of detector.
Tags (dict) --
The detector's tags .
(string) --
(string) --
NextToken (string) --
If the response is truncated, the service returns this token. To retrieve the next set of results, use the token in the next request.
Returns a selection of sample records from an Amazon S3 datasource.
See also: AWS API Documentation
Request Syntax
client.get_sample_data(
S3SourceConfig={
'RoleArn': 'string',
'TemplatedPathList': [
'string',
],
'HistoricalDataPathList': [
'string',
],
'FileFormatDescriptor': {
'CsvFormatDescriptor': {
'FileCompression': 'NONE'|'GZIP',
'Charset': 'string',
'ContainsHeader': True|False,
'Delimiter': 'string',
'HeaderList': [
'string',
],
'QuoteSymbol': 'string'
},
'JsonFormatDescriptor': {
'FileCompression': 'NONE'|'GZIP',
'Charset': 'string'
}
}
}
)
dict
A datasource bucket in Amazon S3.
RoleArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the role.
TemplatedPathList (list) --
An array of strings containing the list of templated paths.
(string) --
HistoricalDataPathList (list) --
An array of strings containing the historical set of data paths.
(string) --
FileFormatDescriptor (dict) -- [REQUIRED]
Contains information about a source file's formatting.
CsvFormatDescriptor (dict) --
Contains information about how a source CSV data file should be analyzed.
FileCompression (string) --
The level of compression of the source CSV file.
Charset (string) --
The character set in which the source CSV file is written.
ContainsHeader (boolean) --
Whether or not the source CSV file contains a header.
Delimiter (string) --
The character used to delimit the source CSV file.
HeaderList (list) --
A list of the source CSV file's headers, if any.
(string) --
QuoteSymbol (string) --
The character used as a quote character.
JsonFormatDescriptor (dict) --
Contains information about how a source JSON data file should be analyzed.
FileCompression (string) --
The level of compression of the source CSV file.
Charset (string) --
The character set in which the source JSON file is written.
dict
Response Syntax
{
'HeaderValues': [
'string',
],
'SampleRows': [
[
'string',
],
]
}
Response Structure
(dict) --
HeaderValues (list) --
A list of header labels for the records.
(string) --
SampleRows (list) --
A list of records.
(list) --
(string) --
Describes a dataset.
See also: AWS API Documentation
Request Syntax
client.describe_metric_set(
MetricSetArn='string'
)
string
[REQUIRED]
The ARN of the dataset.
dict
Response Syntax
{
'MetricSetArn': 'string',
'AnomalyDetectorArn': 'string',
'MetricSetName': 'string',
'MetricSetDescription': 'string',
'CreationTime': datetime(2015, 1, 1),
'LastModificationTime': datetime(2015, 1, 1),
'Offset': 123,
'MetricList': [
{
'MetricName': 'string',
'AggregationFunction': 'AVG'|'SUM',
'Namespace': 'string'
},
],
'TimestampColumn': {
'ColumnName': 'string',
'ColumnFormat': 'string'
},
'DimensionList': [
'string',
],
'MetricSetFrequency': 'P1D'|'PT1H'|'PT10M'|'PT5M',
'Timezone': 'string',
'MetricSource': {
'S3SourceConfig': {
'RoleArn': 'string',
'TemplatedPathList': [
'string',
],
'HistoricalDataPathList': [
'string',
],
'FileFormatDescriptor': {
'CsvFormatDescriptor': {
'FileCompression': 'NONE'|'GZIP',
'Charset': 'string',
'ContainsHeader': True|False,
'Delimiter': 'string',
'HeaderList': [
'string',
],
'QuoteSymbol': 'string'
},
'JsonFormatDescriptor': {
'FileCompression': 'NONE'|'GZIP',
'Charset': 'string'
}
}
},
'AppFlowConfig': {
'RoleArn': 'string',
'FlowName': 'string'
},
'CloudWatchConfig': {
'RoleArn': 'string'
},
'RDSSourceConfig': {
'DBInstanceIdentifier': 'string',
'DatabaseHost': 'string',
'DatabasePort': 123,
'SecretManagerArn': 'string',
'DatabaseName': 'string',
'TableName': 'string',
'RoleArn': 'string',
'VpcConfiguration': {
'SubnetIdList': [
'string',
],
'SecurityGroupIdList': [
'string',
]
}
},
'RedshiftSourceConfig': {
'ClusterIdentifier': 'string',
'DatabaseHost': 'string',
'DatabasePort': 123,
'SecretManagerArn': 'string',
'DatabaseName': 'string',
'TableName': 'string',
'RoleArn': 'string',
'VpcConfiguration': {
'SubnetIdList': [
'string',
],
'SecurityGroupIdList': [
'string',
]
}
}
}
}
Response Structure
(dict) --
MetricSetArn (string) --
The ARN of the dataset.
AnomalyDetectorArn (string) --
The ARN of the detector that contains the dataset.
MetricSetName (string) --
The name of the dataset.
MetricSetDescription (string) --
The dataset's description.
CreationTime (datetime) --
The time at which the dataset was created.
LastModificationTime (datetime) --
The time at which the dataset was last modified.
Offset (integer) --
The offset for the dataset.
MetricList (list) --
A list of the metrics defined by the dataset.
(dict) --
A calculation made by contrasting a measure and a dimension from your source data.
MetricName (string) --
The name of the metric.
AggregationFunction (string) --
The function with which the metric is calculated.
Namespace (string) --
The namespace for the metric.
TimestampColumn (dict) --
Contains information about the column used for tracking time in your source data.
ColumnName (string) --
The name of the timestamp column.
ColumnFormat (string) --
The format of the timestamp column.
DimensionList (list) --
A list of the dimensions chosen for analysis.
(string) --
MetricSetFrequency (string) --
The interval at which the data will be analyzed for anomalies.
Timezone (string) --
The time zone in which the dataset's data was recorded.
MetricSource (dict) --
Contains information about the dataset's source data.
S3SourceConfig (dict) --
Contains information about the configuration of the S3 bucket that contains source files.
RoleArn (string) --
The ARN of an IAM role that has read and write access permissions to the source S3 bucket.
TemplatedPathList (list) --
A list of templated paths to the source files.
(string) --
HistoricalDataPathList (list) --
A list of paths to the historical data files.
(string) --
FileFormatDescriptor (dict) --
Contains information about a source file's formatting.
CsvFormatDescriptor (dict) --
Contains information about how a source CSV data file should be analyzed.
FileCompression (string) --
The level of compression of the source CSV file.
Charset (string) --
The character set in which the source CSV file is written.
ContainsHeader (boolean) --
Whether or not the source CSV file contains a header.
Delimiter (string) --
The character used to delimit the source CSV file.
HeaderList (list) --
A list of the source CSV file's headers, if any.
(string) --
QuoteSymbol (string) --
The character used as a quote character.
JsonFormatDescriptor (dict) --
Contains information about how a source JSON data file should be analyzed.
FileCompression (string) --
The level of compression of the source CSV file.
Charset (string) --
The character set in which the source JSON file is written.
AppFlowConfig (dict) --
An object containing information about the AppFlow configuration.
RoleArn (string) --
An IAM role that gives Amazon Lookout for Metrics permission to access the flow.
FlowName (string) --
The name of the flow.
CloudWatchConfig (dict) --
An object containing information about the Amazon CloudWatch monitoring configuration.
RoleArn (string) --
An IAM role that gives Amazon Lookout for Metrics permission to access data in Amazon CloudWatch.
RDSSourceConfig (dict) --
An object containing information about the Amazon Relational Database Service (RDS) configuration.
DBInstanceIdentifier (string) --
A string identifying the database instance.
DatabaseHost (string) --
The host name of the database.
DatabasePort (integer) --
The port number where the database can be accessed.
SecretManagerArn (string) --
The Amazon Resource Name (ARN) of the AWS Secrets Manager role.
DatabaseName (string) --
The name of the RDS database.
TableName (string) --
The name of the table in the database.
RoleArn (string) --
The Amazon Resource Name (ARN) of the role.
VpcConfiguration (dict) --
An object containing information about the Amazon Virtual Private Cloud (VPC) configuration.
SubnetIdList (list) --
An array of strings containing the Amazon VPC subnet IDs (e.g., subnet-0bb1c79de3EXAMPLE .
(string) --
SecurityGroupIdList (list) --
An array of strings containing the list of security groups.
(string) --
RedshiftSourceConfig (dict) --
An object containing information about the Amazon Redshift database configuration.
ClusterIdentifier (string) --
A string identifying the Redshift cluster.
DatabaseHost (string) --
The name of the database host.
DatabasePort (integer) --
The port number where the database can be accessed.
SecretManagerArn (string) --
The Amazon Resource Name (ARN) of the AWS Secrets Manager role.
DatabaseName (string) --
The Redshift database name.
TableName (string) --
The table name of the Redshift database.
RoleArn (string) --
The Amazon Resource Name (ARN) of the role providing access to the database.
VpcConfiguration (dict) --
Contains information about the Amazon Virtual Private Cloud (VPC) configuration.
SubnetIdList (list) --
An array of strings containing the Amazon VPC subnet IDs (e.g., subnet-0bb1c79de3EXAMPLE .
(string) --
SecurityGroupIdList (list) --
An array of strings containing the list of security groups.
(string) --
Lists the datasets in the current AWS Region.
See also: AWS API Documentation
Request Syntax
client.list_metric_sets(
AnomalyDetectorArn='string',
MaxResults=123,
NextToken='string'
)
string
The ARN of the anomaly detector containing the metrics sets to list.
integer
The maximum number of results to return.
string
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.
dict
Response Syntax
{
'MetricSetSummaryList': [
{
'MetricSetArn': 'string',
'AnomalyDetectorArn': 'string',
'MetricSetDescription': 'string',
'MetricSetName': 'string',
'CreationTime': datetime(2015, 1, 1),
'LastModificationTime': datetime(2015, 1, 1),
'Tags': {
'string': 'string'
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
MetricSetSummaryList (list) --
A list of the datasets in the AWS Region, with configuration details for each.
(dict) --
Contains information about a dataset.
MetricSetArn (string) --
The ARN of the dataset.
AnomalyDetectorArn (string) --
The ARN of the detector to which the dataset belongs.
MetricSetDescription (string) --
The description of the dataset.
MetricSetName (string) --
The name of the dataset.
CreationTime (datetime) --
The time at which the dataset was created.
LastModificationTime (datetime) --
The time at which the dataset was last modified.
Tags (dict) --
The dataset's tags .
(string) --
(string) --
NextToken (string) --
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.
Gets a list of tags for a detector, dataset, or alert.
See also: AWS API Documentation
Request Syntax
client.list_tags_for_resource(
ResourceArn='string'
)
string
[REQUIRED]
The resource's Amazon Resource Name (ARN).
dict
Response Syntax
{
'Tags': {
'string': 'string'
}
}
Response Structure
(dict) --
Tags (dict) --
The resource's tags.
(string) --
(string) --
Runs a backtest for anomaly detection for the specified resource.
See also: AWS API Documentation
Request Syntax
client.back_test_anomaly_detector(
AnomalyDetectorArn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the anomaly detector.
dict
Response Syntax
{}
Response Structure
(dict) --
Returns information about the status of the specified anomaly detection jobs.
See also: AWS API Documentation
Request Syntax
client.describe_anomaly_detection_executions(
AnomalyDetectorArn='string',
Timestamp='string',
MaxResults=123,
NextToken='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the anomaly detector.
string
The timestamp of the anomaly detection job.
integer
The number of items to return in the response.
string
Specify the pagination token that's returned by a previous request to retrieve the next page of results.
dict
Response Syntax
{
'ExecutionList': [
{
'Timestamp': 'string',
'Status': 'PENDING'|'IN_PROGRESS'|'COMPLETED'|'FAILED'|'FAILED_TO_SCHEDULE',
'FailureReason': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
ExecutionList (list) --
A list of detection jobs.
(dict) --
The status of an anomaly detector run.
Timestamp (string) --
The run's timestamp.
Status (string) --
The run's status.
FailureReason (string) --
The reason that the run failed, if applicable.
NextToken (string) --
The pagination token that's included if more results are available.
Creates an anomaly detector.
See also: AWS API Documentation
Request Syntax
client.create_anomaly_detector(
AnomalyDetectorName='string',
AnomalyDetectorDescription='string',
AnomalyDetectorConfig={
'AnomalyDetectorFrequency': 'P1D'|'PT1H'|'PT10M'|'PT5M'
},
KmsKeyArn='string',
Tags={
'string': 'string'
}
)
string
[REQUIRED]
The name of the detector.
string
A description of the detector.
dict
[REQUIRED]
Contains information about the configuration of the anomaly detector.
AnomalyDetectorFrequency (string) --
The frequency at which the detector analyzes its source data.
string
The ARN of the KMS key to use to encrypt your data.
dict
A list of tags to apply to the anomaly detector.
(string) --
(string) --
dict
Response Syntax
{
'AnomalyDetectorArn': 'string'
}
Response Structure
(dict) --
AnomalyDetectorArn (string) --
The ARN of the detector.
Add feedback for an anomalous metric.
See also: AWS API Documentation
Request Syntax
client.put_feedback(
AnomalyDetectorArn='string',
AnomalyGroupTimeSeriesFeedback={
'AnomalyGroupId': 'string',
'TimeSeriesId': 'string',
'IsAnomaly': True|False
}
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the anomaly detector.
dict
[REQUIRED]
Feedback for an anomalous metric.
AnomalyGroupId (string) -- [REQUIRED]
The ID of the anomaly group.
TimeSeriesId (string) -- [REQUIRED]
The ID of the metric.
IsAnomaly (boolean) -- [REQUIRED]
Feedback on whether the metric is a legitimate anomaly.
dict
Response Syntax
{}
Response Structure
(dict) --
Deletes a detector. Deleting an anomaly detector will delete all of its corresponding resources including any configured datasets and alerts.
See also: AWS API Documentation
Request Syntax
client.delete_anomaly_detector(
AnomalyDetectorArn='string'
)
string
[REQUIRED]
The ARN of the detector to delete.
dict
Response Syntax
{}
Response Structure
(dict) --
Deletes an alert.
See also: AWS API Documentation
Request Syntax
client.delete_alert(
AlertArn='string'
)
string
[REQUIRED]
The ARN of the alert to delete.
dict
Response Syntax
{}
Response Structure
(dict) --
Gets a list of anomalous metrics for a measure in an anomaly group.
See also: AWS API Documentation
Request Syntax
client.list_anomaly_group_time_series(
AnomalyDetectorArn='string',
AnomalyGroupId='string',
MetricName='string',
MaxResults=123,
NextToken='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the anomaly detector.
string
[REQUIRED]
The ID of the anomaly group.
string
[REQUIRED]
The name of the measure field.
integer
The maximum number of results to return.
string
Specify the pagination token that's returned by a previous request to retrieve the next page of results.
dict
Response Syntax
{
'AnomalyGroupId': 'string',
'MetricName': 'string',
'TimestampList': [
'string',
],
'NextToken': 'string',
'TimeSeriesList': [
{
'TimeSeriesId': 'string',
'DimensionList': [
{
'DimensionName': 'string',
'DimensionValue': 'string'
},
],
'MetricValueList': [
123.0,
]
},
]
}
Response Structure
(dict) --
AnomalyGroupId (string) --
The ID of the anomaly group.
MetricName (string) --
The name of the measure field.
TimestampList (list) --
Timestamps for the anomalous metrics.
(string) --
NextToken (string) --
The pagination token that's included if more results are available.
TimeSeriesList (list) --
A list of anomalous metrics.
(dict) --
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.
TimeSeriesId (string) --
The ID of the metric.
DimensionList (list) --
The dimensions of the metric.
(dict) --
A dimension name and value.
DimensionName (string) --
The name of the dimension.
DimensionValue (string) --
The value of the dimension.
MetricValueList (list) --
The values for the metric.
(float) --
Creates an alert for an anomaly detector.
See also: AWS API Documentation
Request Syntax
client.create_alert(
AlertName='string',
AlertSensitivityThreshold=123,
AlertDescription='string',
AnomalyDetectorArn='string',
Action={
'SNSConfiguration': {
'RoleArn': 'string',
'SnsTopicArn': 'string'
},
'LambdaConfiguration': {
'RoleArn': 'string',
'LambdaArn': 'string'
}
},
Tags={
'string': 'string'
}
)
string
[REQUIRED]
The name of the alert.
integer
[REQUIRED]
An integer from 0 to 100 specifying the alert sensitivity threshold.
string
A description of the alert.
string
[REQUIRED]
The ARN of the detector to which the alert is attached.
dict
[REQUIRED]
Action that will be triggered when there is an alert.
SNSConfiguration (dict) --
A configuration for an Amazon SNS channel.
RoleArn (string) -- [REQUIRED]
THe ARN of the IAM role that has access to the target SNS topic.
SnsTopicArn (string) -- [REQUIRED]
The ARN of the target SNS topic.
LambdaConfiguration (dict) --
A configuration for an AWS Lambda channel.
RoleArn (string) -- [REQUIRED]
The ARN of an IAM role that has permission to invoke the Lambda function.
LambdaArn (string) -- [REQUIRED]
The ARN of the Lambda function.
dict
A list of tags to apply to the alert.
(string) --
(string) --
dict
Response Syntax
{
'AlertArn': 'string'
}
Response Structure
(dict) --
AlertArn (string) --
The ARN of the alert.