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
# LookoutMetricsClient usage example
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.
# Exceptions.exceptions usage example
client = boto3.client("lookoutmetrics")
try:
do_something(client)
except (
client.exceptions.AccessDeniedException,
client.exceptions.ClientError,
client.exceptions.ConflictException,
client.exceptions.InternalServerException,
client.exceptions.ResourceNotFoundException,
client.exceptions.ServiceQuotaExceededException,
client.exceptions.TooManyRequestsException,
client.exceptions.ValidationException,
) as e:
print(e)
# Exceptions.exceptions type checking example
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
# activate_anomaly_detector method definition
def activate_anomaly_detector(
self,
*,
AnomalyDetectorArn: str,
) -> Dict[str, Any]:
...
# activate_anomaly_detector method usage example with argument unpacking
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
# back_test_anomaly_detector method definition
def back_test_anomaly_detector(
self,
*,
AnomalyDetectorArn: str,
) -> Dict[str, Any]:
...
# back_test_anomaly_detector method usage example with argument unpacking
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
# can_paginate method definition
def can_paginate(
self,
operation_name: str,
) -> bool:
...
close#
Closes underlying endpoint connections.
Type annotations and code completion for boto3.client("lookoutmetrics").close
method.
boto3 documentation
# close method definition
def close(
self,
) -> None:
...
create_alert#
Creates an alert for an anomaly detector.
Type annotations and code completion for boto3.client("lookoutmetrics").create_alert
method.
boto3 documentation
# create_alert method definition
def create_alert(
self,
*,
AlertName: str,
AnomalyDetectorArn: str,
Action: ActionTypeDef, # (1)
AlertSensitivityThreshold: int = ...,
AlertDescription: str = ...,
Tags: Mapping[str, str] = ...,
AlertFilters: AlertFiltersTypeDef = ..., # (2)
) -> CreateAlertResponseTypeDef: # (3)
...
# create_alert method usage example with argument unpacking
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
# create_anomaly_detector method definition
def create_anomaly_detector(
self,
*,
AnomalyDetectorName: str,
AnomalyDetectorConfig: AnomalyDetectorConfigTypeDef, # (1)
AnomalyDetectorDescription: str = ...,
KmsKeyArn: str = ...,
Tags: Mapping[str, str] = ...,
) -> CreateAnomalyDetectorResponseTypeDef: # (2)
...
# create_anomaly_detector method usage example with argument unpacking
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
# create_metric_set method definition
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
# create_metric_set method usage example with argument unpacking
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
# deactivate_anomaly_detector method definition
def deactivate_anomaly_detector(
self,
*,
AnomalyDetectorArn: str,
) -> Dict[str, Any]:
...
# deactivate_anomaly_detector method usage example with argument unpacking
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
# delete_alert method definition
def delete_alert(
self,
*,
AlertArn: str,
) -> Dict[str, Any]:
...
# delete_alert method usage example with argument unpacking
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
# delete_anomaly_detector method definition
def delete_anomaly_detector(
self,
*,
AnomalyDetectorArn: str,
) -> Dict[str, Any]:
...
# delete_anomaly_detector method usage example with argument unpacking
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
# describe_alert method definition
def describe_alert(
self,
*,
AlertArn: str,
) -> DescribeAlertResponseTypeDef: # (1)
...
# describe_alert method usage example with argument unpacking
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
# describe_anomaly_detection_executions method definition
def describe_anomaly_detection_executions(
self,
*,
AnomalyDetectorArn: str,
Timestamp: str = ...,
MaxResults: int = ...,
NextToken: str = ...,
) -> DescribeAnomalyDetectionExecutionsResponseTypeDef: # (1)
...
# describe_anomaly_detection_executions method usage example with argument unpacking
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
# describe_anomaly_detector method definition
def describe_anomaly_detector(
self,
*,
AnomalyDetectorArn: str,
) -> DescribeAnomalyDetectorResponseTypeDef: # (1)
...
# describe_anomaly_detector method usage example with argument unpacking
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
# describe_metric_set method definition
def describe_metric_set(
self,
*,
MetricSetArn: str,
) -> DescribeMetricSetResponseTypeDef: # (1)
...
# describe_metric_set method usage example with argument unpacking
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
# detect_metric_set_config method definition
def detect_metric_set_config(
self,
*,
AnomalyDetectorArn: str,
AutoDetectionMetricSource: AutoDetectionMetricSourceTypeDef, # (1)
) -> DetectMetricSetConfigResponseTypeDef: # (2)
...
# detect_metric_set_config method usage example with argument unpacking
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
# generate_presigned_url method definition
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
# get_anomaly_group method definition
def get_anomaly_group(
self,
*,
AnomalyGroupId: str,
AnomalyDetectorArn: str,
) -> GetAnomalyGroupResponseTypeDef: # (1)
...
# get_anomaly_group method usage example with argument unpacking
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
# get_data_quality_metrics method definition
def get_data_quality_metrics(
self,
*,
AnomalyDetectorArn: str,
MetricSetArn: str = ...,
) -> GetDataQualityMetricsResponseTypeDef: # (1)
...
# get_data_quality_metrics method usage example with argument unpacking
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.