LookoutMetricsClient
Index > LookoutMetrics > LookoutMetricsClient
Auto-generated documentation for LookoutMetrics type annotations stubs module mypy-boto3-lookoutmetrics.
LookoutMetricsClient
Type annotations and code completion for boto3.client("lookoutmetrics")
.
boto3 documentation
from boto3.session import Session
from mypy_boto3_lookoutmetrics.client import LookoutMetricsClient
def get_lookoutmetrics_client() -> LookoutMetricsClient:
return Session().client("lookoutmetrics")
Exceptions
boto3
client exceptions are generated in runtime.
This class provides code completion for boto3.client("lookoutmetrics").exceptions
structure.
client = boto3.client("lookoutmetrics")
try:
do_something(client)
except (
client.AccessDeniedException,
client.ClientError,
client.ConflictException,
client.InternalServerException,
client.ResourceNotFoundException,
client.ServiceQuotaExceededException,
client.TooManyRequestsException,
client.ValidationException,
) as e:
print(e)
from mypy_boto3_lookoutmetrics.client import Exceptions
def handle_error(exc: Exceptions.AccessDeniedException) -> None:
...
Methods
activate_anomaly_detector
Activates an anomaly detector.
Type annotations and code completion for boto3.client("lookoutmetrics").activate_anomaly_detector
method.
boto3 documentation
def activate_anomaly_detector(
self,
*,
AnomalyDetectorArn: str,
) -> Dict[str, Any]:
...
kwargs: ActivateAnomalyDetectorRequestRequestTypeDef = { # (1)
"AnomalyDetectorArn": ...,
}
parent.activate_anomaly_detector(**kwargs)
back_test_anomaly_detector
Runs a backtest for anomaly detection for the specified resource.
Type annotations and code completion for boto3.client("lookoutmetrics").back_test_anomaly_detector
method.
boto3 documentation
def back_test_anomaly_detector(
self,
*,
AnomalyDetectorArn: str,
) -> Dict[str, Any]:
...
kwargs: BackTestAnomalyDetectorRequestRequestTypeDef = { # (1)
"AnomalyDetectorArn": ...,
}
parent.back_test_anomaly_detector(**kwargs)
can_paginate
Check if an operation can be paginated.
Type annotations and code completion for boto3.client("lookoutmetrics").can_paginate
method.
boto3 documentation
close
Closes underlying endpoint connections.
Type annotations and code completion for boto3.client("lookoutmetrics").close
method.
boto3 documentation
create_alert
Creates an alert for an anomaly detector.
Type annotations and code completion for boto3.client("lookoutmetrics").create_alert
method.
boto3 documentation
def create_alert(
self,
*,
AlertName: str,
AnomalyDetectorArn: str,
Action: ActionTypeDef, # (1)
AlertSensitivityThreshold: int = ...,
AlertDescription: str = ...,
Tags: Mapping[str, str] = ...,
AlertFilters: AlertFiltersTypeDef = ..., # (2)
) -> CreateAlertResponseTypeDef: # (3)
...
kwargs: CreateAlertRequestRequestTypeDef = { # (1)
"AlertName": ...,
"AnomalyDetectorArn": ...,
"Action": ...,
}
parent.create_alert(**kwargs)
create_anomaly_detector
Creates an anomaly detector.
Type annotations and code completion for boto3.client("lookoutmetrics").create_anomaly_detector
method.
boto3 documentation
def create_anomaly_detector(
self,
*,
AnomalyDetectorName: str,
AnomalyDetectorConfig: AnomalyDetectorConfigTypeDef, # (1)
AnomalyDetectorDescription: str = ...,
KmsKeyArn: str = ...,
Tags: Mapping[str, str] = ...,
) -> CreateAnomalyDetectorResponseTypeDef: # (2)
...
kwargs: CreateAnomalyDetectorRequestRequestTypeDef = { # (1)
"AnomalyDetectorName": ...,
"AnomalyDetectorConfig": ...,
}
parent.create_anomaly_detector(**kwargs)
create_metric_set
Creates a dataset.
Type annotations and code completion for boto3.client("lookoutmetrics").create_metric_set
method.
boto3 documentation
def create_metric_set(
self,
*,
AnomalyDetectorArn: str,
MetricSetName: str,
MetricList: Sequence[MetricTypeDef], # (1)
MetricSource: MetricSourceTypeDef, # (2)
MetricSetDescription: str = ...,
Offset: int = ...,
TimestampColumn: TimestampColumnTypeDef = ..., # (3)
DimensionList: Sequence[str] = ...,
MetricSetFrequency: FrequencyType = ..., # (4)
Timezone: str = ...,
Tags: Mapping[str, str] = ...,
DimensionFilterList: Sequence[MetricSetDimensionFilterTypeDef] = ..., # (5)
) -> CreateMetricSetResponseTypeDef: # (6)
...
- See MetricTypeDef
- See MetricSourceTypeDef
- See TimestampColumnTypeDef
- See FrequencyType
- See MetricSetDimensionFilterTypeDef
- See CreateMetricSetResponseTypeDef
kwargs: CreateMetricSetRequestRequestTypeDef = { # (1)
"AnomalyDetectorArn": ...,
"MetricSetName": ...,
"MetricList": ...,
"MetricSource": ...,
}
parent.create_metric_set(**kwargs)
deactivate_anomaly_detector
Deactivates an anomaly detector.
Type annotations and code completion for boto3.client("lookoutmetrics").deactivate_anomaly_detector
method.
boto3 documentation
def deactivate_anomaly_detector(
self,
*,
AnomalyDetectorArn: str,
) -> Dict[str, Any]:
...
kwargs: DeactivateAnomalyDetectorRequestRequestTypeDef = { # (1)
"AnomalyDetectorArn": ...,
}
parent.deactivate_anomaly_detector(**kwargs)
delete_alert
Deletes an alert.
Type annotations and code completion for boto3.client("lookoutmetrics").delete_alert
method.
boto3 documentation
kwargs: DeleteAlertRequestRequestTypeDef = { # (1)
"AlertArn": ...,
}
parent.delete_alert(**kwargs)
delete_anomaly_detector
Deletes a detector.
Type annotations and code completion for boto3.client("lookoutmetrics").delete_anomaly_detector
method.
boto3 documentation
def delete_anomaly_detector(
self,
*,
AnomalyDetectorArn: str,
) -> Dict[str, Any]:
...
kwargs: DeleteAnomalyDetectorRequestRequestTypeDef = { # (1)
"AnomalyDetectorArn": ...,
}
parent.delete_anomaly_detector(**kwargs)
describe_alert
Describes an alert.
Type annotations and code completion for boto3.client("lookoutmetrics").describe_alert
method.
boto3 documentation
def describe_alert(
self,
*,
AlertArn: str,
) -> DescribeAlertResponseTypeDef: # (1)
...
kwargs: DescribeAlertRequestRequestTypeDef = { # (1)
"AlertArn": ...,
}
parent.describe_alert(**kwargs)
describe_anomaly_detection_executions
Returns information about the status of the specified anomaly detection jobs.
Type annotations and code completion for boto3.client("lookoutmetrics").describe_anomaly_detection_executions
method.
boto3 documentation
def describe_anomaly_detection_executions(
self,
*,
AnomalyDetectorArn: str,
Timestamp: str = ...,
MaxResults: int = ...,
NextToken: str = ...,
) -> DescribeAnomalyDetectionExecutionsResponseTypeDef: # (1)
...
kwargs: DescribeAnomalyDetectionExecutionsRequestRequestTypeDef = { # (1)
"AnomalyDetectorArn": ...,
}
parent.describe_anomaly_detection_executions(**kwargs)
describe_anomaly_detector
Describes a detector.
Type annotations and code completion for boto3.client("lookoutmetrics").describe_anomaly_detector
method.
boto3 documentation
def describe_anomaly_detector(
self,
*,
AnomalyDetectorArn: str,
) -> DescribeAnomalyDetectorResponseTypeDef: # (1)
...
kwargs: DescribeAnomalyDetectorRequestRequestTypeDef = { # (1)
"AnomalyDetectorArn": ...,
}
parent.describe_anomaly_detector(**kwargs)
describe_metric_set
Describes a dataset.
Type annotations and code completion for boto3.client("lookoutmetrics").describe_metric_set
method.
boto3 documentation
def describe_metric_set(
self,
*,
MetricSetArn: str,
) -> DescribeMetricSetResponseTypeDef: # (1)
...
kwargs: DescribeMetricSetRequestRequestTypeDef = { # (1)
"MetricSetArn": ...,
}
parent.describe_metric_set(**kwargs)
detect_metric_set_config
Detects an Amazon S3 dataset's file format, interval, and offset.
Type annotations and code completion for boto3.client("lookoutmetrics").detect_metric_set_config
method.
boto3 documentation
def detect_metric_set_config(
self,
*,
AnomalyDetectorArn: str,
AutoDetectionMetricSource: AutoDetectionMetricSourceTypeDef, # (1)
) -> DetectMetricSetConfigResponseTypeDef: # (2)
...
kwargs: DetectMetricSetConfigRequestRequestTypeDef = { # (1)
"AnomalyDetectorArn": ...,
"AutoDetectionMetricSource": ...,
}
parent.detect_metric_set_config(**kwargs)
generate_presigned_url
Generate a presigned url given a client, its method, and arguments.
Type annotations and code completion for boto3.client("lookoutmetrics").generate_presigned_url
method.
boto3 documentation
def generate_presigned_url(
self,
ClientMethod: str,
Params: Mapping[str, Any] = ...,
ExpiresIn: int = 3600,
HttpMethod: str = ...,
) -> str:
...
get_anomaly_group
Returns details about a group of anomalous metrics.
Type annotations and code completion for boto3.client("lookoutmetrics").get_anomaly_group
method.
boto3 documentation
def get_anomaly_group(
self,
*,
AnomalyGroupId: str,
AnomalyDetectorArn: str,
) -> GetAnomalyGroupResponseTypeDef: # (1)
...
kwargs: GetAnomalyGroupRequestRequestTypeDef = { # (1)
"AnomalyGroupId": ...,
"AnomalyDetectorArn": ...,
}
parent.get_anomaly_group(**kwargs)
get_data_quality_metrics
Returns details about the requested data quality metrics.
Type annotations and code completion for boto3.client("lookoutmetrics").get_data_quality_metrics
method.
boto3 documentation
def get_data_quality_metrics(
self,
*,
AnomalyDetectorArn: str,
MetricSetArn: str = ...,
) -> GetDataQualityMetricsResponseTypeDef: # (1)
...
kwargs: GetDataQualityMetricsRequestRequestTypeDef = { # (1)
"AnomalyDetectorArn": ...,
}
parent.get_data_quality_metrics(**kwargs)
get_feedback
Get feedback for an anomaly group.
Type annotations and code completion for boto3.client("lookoutmetrics").get_feedback
method.
boto3 documentation
def get_feedback(
self,
*,
AnomalyDetectorArn: str,
AnomalyGroupTimeSeriesFeedback: AnomalyGroupTimeSeriesTypeDef, # (1)
MaxResults: int = ...,
NextToken: str = ...,
) -> GetFeedbackResponseTypeDef: # (2)
...
kwargs: GetFeedbackRequestRequestTypeDef = { # (1)
"AnomalyDetectorArn": ...,
"AnomalyGroupTimeSeriesFeedback": ...,
}
parent.get_feedback(**kwargs)
get_sample_data
Returns a selection of sample records from an Amazon S3 datasource.
Type annotations and code completion for boto3.client("lookoutmetrics").get_sample_data
method.
boto3 documentation
def get_sample_data(
self,
*,
S3SourceConfig: SampleDataS3SourceConfigTypeDef = ..., # (1)
) -> GetSampleDataResponseTypeDef: # (2)
...
kwargs: GetSampleDataRequestRequestTypeDef = { # (1)
"S3SourceConfig": ...,
}
parent.get_sample_data(**kwargs)
list_alerts
Lists the alerts attached to a detector.
Type annotations and code completion for boto3.client("lookoutmetrics").list_alerts
method.
boto3 documentation
def list_alerts(
self,
*,
AnomalyDetectorArn: str = ...,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListAlertsResponseTypeDef: # (1)
...
kwargs: ListAlertsRequestRequestTypeDef = { # (1)
"AnomalyDetectorArn": ...,
}
parent.list_alerts(**kwargs)
list_anomaly_detectors
Lists the detectors in the current AWS Region.
Type annotations and code completion for boto3.client("lookoutmetrics").list_anomaly_detectors
method.
boto3 documentation
def list_anomaly_detectors(
self,
*,
MaxResults: int = ...,
NextToken: str = ...,
) -> ListAnomalyDetectorsResponseTypeDef: # (1)
...
kwargs: ListAnomalyDetectorsRequestRequestTypeDef = { # (1)
"MaxResults": ...,
}
parent.list_anomaly_detectors(**kwargs)
list_anomaly_group_related_metrics
Returns a list of measures that are potential causes or effects of an anomaly group.
Type annotations and code completion for boto3.client("lookoutmetrics").list_anomaly_group_related_metrics
method.
boto3 documentation
def list_anomaly_group_related_metrics(
self,
*,
AnomalyDetectorArn: str,
AnomalyGroupId: str,
RelationshipTypeFilter: RelationshipTypeType = ..., # (1)
MaxResults: int = ...,
NextToken: str = ...,
) -> ListAnomalyGroupRelatedMetricsResponseTypeDef: # (2)
...
kwargs: ListAnomalyGroupRelatedMetricsRequestRequestTypeDef = { # (1)
"AnomalyDetectorArn": ...,
"AnomalyGroupId": ...,
}
parent.list_anomaly_group_related_metrics(**kwargs)
list_anomaly_group_summaries
Returns a list of anomaly groups.
Type annotations and code completion for boto3.client("lookoutmetrics").list_anomaly_group_summaries
method.
boto3 documentation
def list_anomaly_group_summaries(
self,
*,
AnomalyDetectorArn: str,
SensitivityThreshold: int,
MaxResults: int = ...,
NextToken: str = ...,
) -> ListAnomalyGroupSummariesResponseTypeDef: # (1)
...
kwargs: ListAnomalyGroupSummariesRequestRequestTypeDef = { # (1)
"AnomalyDetectorArn": ...,
"SensitivityThreshold": ...,
}
parent.list_anomaly_group_summaries(**kwargs)
list_anomaly_group_time_series
Gets a list of anomalous metrics for a measure in an anomaly group.
Type annotations and code completion for boto3.client("lookoutmetrics").list_anomaly_group_time_series
method.
boto3 documentation
def list_anomaly_group_time_series(
self,
*,
AnomalyDetectorArn: str,
AnomalyGroupId: str,
MetricName: str,
MaxResults: int = ...,
NextToken: str = ...,
) -> ListAnomalyGroupTimeSeriesResponseTypeDef: # (1)
...
kwargs: ListAnomalyGroupTimeSeriesRequestRequestTypeDef = { # (1)
"AnomalyDetectorArn": ...,
"AnomalyGroupId": ...,
"MetricName": ...,
}
parent.list_anomaly_group_time_series(**kwargs)
list_metric_sets
Lists the datasets in the current AWS Region.
Type annotations and code completion for boto3.client("lookoutmetrics").list_metric_sets
method.
boto3 documentation
def list_metric_sets(
self,
*,
AnomalyDetectorArn: str = ...,
MaxResults: int = ...,
NextToken: str = ...,
) -> ListMetricSetsResponseTypeDef: # (1)
...
kwargs: ListMetricSetsRequestRequestTypeDef = { # (1)
"AnomalyDetectorArn": ...,
}
parent.list_metric_sets(**kwargs)
list_tags_for_resource
Gets a list of tags_ for a detector, dataset, or alert.
Type annotations and code completion for boto3.client("lookoutmetrics").list_tags_for_resource
method.
boto3 documentation
def list_tags_for_resource(
self,
*,
ResourceArn: str,
) -> ListTagsForResourceResponseTypeDef: # (1)
...
kwargs: ListTagsForResourceRequestRequestTypeDef = { # (1)
"ResourceArn": ...,
}
parent.list_tags_for_resource(**kwargs)
put_feedback
Add feedback for an anomalous metric.
Type annotations and code completion for boto3.client("lookoutmetrics").put_feedback
method.
boto3 documentation
def put_feedback(
self,
*,
AnomalyDetectorArn: str,
AnomalyGroupTimeSeriesFeedback: AnomalyGroupTimeSeriesFeedbackTypeDef, # (1)
) -> Dict[str, Any]:
...
kwargs: PutFeedbackRequestRequestTypeDef = { # (1)
"AnomalyDetectorArn": ...,
"AnomalyGroupTimeSeriesFeedback": ...,
}
parent.put_feedback(**kwargs)
tag_resource
Adds tags_ to a detector, dataset, or alert.
Type annotations and code completion for boto3.client("lookoutmetrics").tag_resource
method.
boto3 documentation
def tag_resource(
self,
*,
ResourceArn: str,
Tags: Mapping[str, str],
) -> Dict[str, Any]:
...
kwargs: TagResourceRequestRequestTypeDef = { # (1)
"ResourceArn": ...,
"Tags": ...,
}
parent.tag_resource(**kwargs)
untag_resource
Removes tags_ from a detector, dataset, or alert.
Type annotations and code completion for boto3.client("lookoutmetrics").untag_resource
method.
boto3 documentation
def untag_resource(
self,
*,
ResourceArn: str,
TagKeys: Sequence[str],
) -> Dict[str, Any]:
...
kwargs: UntagResourceRequestRequestTypeDef = { # (1)
"ResourceArn": ...,
"TagKeys": ...,
}
parent.untag_resource(**kwargs)
update_alert
Make changes to an existing alert.
Type annotations and code completion for boto3.client("lookoutmetrics").update_alert
method.
boto3 documentation
def update_alert(
self,
*,
AlertArn: str,
AlertDescription: str = ...,
AlertSensitivityThreshold: int = ...,
Action: ActionTypeDef = ..., # (1)
AlertFilters: AlertFiltersTypeDef = ..., # (2)
) -> UpdateAlertResponseTypeDef: # (3)
...
kwargs: UpdateAlertRequestRequestTypeDef = { # (1)
"AlertArn": ...,
}
parent.update_alert(**kwargs)
update_anomaly_detector
Updates a detector.
Type annotations and code completion for boto3.client("lookoutmetrics").update_anomaly_detector
method.
boto3 documentation
def update_anomaly_detector(
self,
*,
AnomalyDetectorArn: str,
KmsKeyArn: str = ...,
AnomalyDetectorDescription: str = ...,
AnomalyDetectorConfig: AnomalyDetectorConfigTypeDef = ..., # (1)
) -> UpdateAnomalyDetectorResponseTypeDef: # (2)
...
kwargs: UpdateAnomalyDetectorRequestRequestTypeDef = { # (1)
"AnomalyDetectorArn": ...,
}
parent.update_anomaly_detector(**kwargs)
update_metric_set
Updates a dataset.
Type annotations and code completion for boto3.client("lookoutmetrics").update_metric_set
method.
boto3 documentation
def update_metric_set(
self,
*,
MetricSetArn: str,
MetricSetDescription: str = ...,
MetricList: Sequence[MetricTypeDef] = ..., # (1)
Offset: int = ...,
TimestampColumn: TimestampColumnTypeDef = ..., # (2)
DimensionList: Sequence[str] = ...,
MetricSetFrequency: FrequencyType = ..., # (3)
MetricSource: MetricSourceTypeDef = ..., # (4)
DimensionFilterList: Sequence[MetricSetDimensionFilterTypeDef] = ..., # (5)
) -> UpdateMetricSetResponseTypeDef: # (6)
...