Skip to content

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)
  1. See ActivateAnomalyDetectorRequestRequestTypeDef

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)
  1. See BackTestAnomalyDetectorRequestRequestTypeDef

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)
    ...
  1. See ActionTypeDef
  2. See AlertFiltersTypeDef
  3. See CreateAlertResponseTypeDef
# create_alert method usage example with argument unpacking

kwargs: CreateAlertRequestRequestTypeDef = {  # (1)
    "AlertName": ...,
    "AnomalyDetectorArn": ...,
    "Action": ...,
}

parent.create_alert(**kwargs)
  1. See CreateAlertRequestRequestTypeDef

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)
    ...
  1. See AnomalyDetectorConfigTypeDef
  2. See CreateAnomalyDetectorResponseTypeDef
# create_anomaly_detector method usage example with argument unpacking

kwargs: CreateAnomalyDetectorRequestRequestTypeDef = {  # (1)
    "AnomalyDetectorName": ...,
    "AnomalyDetectorConfig": ...,
}

parent.create_anomaly_detector(**kwargs)
  1. See CreateAnomalyDetectorRequestRequestTypeDef

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)
    ...
  1. See MetricTypeDef
  2. See MetricSourceTypeDef
  3. See TimestampColumnTypeDef
  4. See FrequencyType
  5. See MetricSetDimensionFilterTypeDef
  6. See CreateMetricSetResponseTypeDef
# create_metric_set method usage example with argument unpacking

kwargs: CreateMetricSetRequestRequestTypeDef = {  # (1)
    "AnomalyDetectorArn": ...,
    "MetricSetName": ...,
    "MetricList": ...,
    "MetricSource": ...,
}

parent.create_metric_set(**kwargs)
  1. See CreateMetricSetRequestRequestTypeDef

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)
  1. See DeactivateAnomalyDetectorRequestRequestTypeDef

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)
  1. See DeleteAlertRequestRequestTypeDef

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)
  1. See DeleteAnomalyDetectorRequestRequestTypeDef

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)
    ...
  1. See DescribeAlertResponseTypeDef
# describe_alert method usage example with argument unpacking

kwargs: DescribeAlertRequestRequestTypeDef = {  # (1)
    "AlertArn": ...,
}

parent.describe_alert(**kwargs)
  1. See DescribeAlertRequestRequestTypeDef

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)
    ...
  1. See DescribeAnomalyDetectionExecutionsResponseTypeDef
# describe_anomaly_detection_executions method usage example with argument unpacking

kwargs: DescribeAnomalyDetectionExecutionsRequestRequestTypeDef = {  # (1)
    "AnomalyDetectorArn": ...,
}

parent.describe_anomaly_detection_executions(**kwargs)
  1. See DescribeAnomalyDetectionExecutionsRequestRequestTypeDef

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)
    ...
  1. See DescribeAnomalyDetectorResponseTypeDef
# describe_anomaly_detector method usage example with argument unpacking

kwargs: DescribeAnomalyDetectorRequestRequestTypeDef = {  # (1)
    "AnomalyDetectorArn": ...,
}

parent.describe_anomaly_detector(**kwargs)
  1. See DescribeAnomalyDetectorRequestRequestTypeDef

describe_metric_set#

Describes a dataset.

Type annotations and code completion for boto3.client("lookoutmetrics").describe_metric_set method.