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[MetricSetDimensionFilterUnionTypeDef] = ...,  # (5)
) -> CreateMetricSetResponseTypeDef:  # (6)
    ...

1. See MetricTypeDef
2. See MetricSourceTypeDef
3. See TimestampColumnTypeDef
4. See FrequencyType
5. See MetricSetDimensionFilterTypeDef MetricSetDimensionFilterOutputTypeDef
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. boto3 documentation

# describe_metric_set method definition

def describe_metric_set(
    self,
    *,
    MetricSetArn: str,
) -> DescribeMetricSetResponseTypeDef:  # (1)
    ...

1. See DescribeMetricSetResponseTypeDef

# describe_metric_set method usage example with argument unpacking

kwargs: DescribeMetricSetRequestRequestTypeDef = {  # (1)
    "MetricSetArn": ...,
}

parent.describe_metric_set(**kwargs)

1. See DescribeMetricSetRequestRequestTypeDef

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)
    ...

1. See AutoDetectionMetricSourceTypeDef
2. See DetectMetricSetConfigResponseTypeDef

# detect_metric_set_config method usage example with argument unpacking

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

parent.detect_metric_set_config(**kwargs)

1. See DetectMetricSetConfigRequestRequestTypeDef

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)
    ...

1. See GetAnomalyGroupResponseTypeDef

# get_anomaly_group method usage example with argument unpacking

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

parent.get_anomaly_group(**kwargs)

1. See GetAnomalyGroupRequestRequestTypeDef

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)
    ...

1. See GetDataQualityMetricsResponseTypeDef

# get_data_quality_metrics method usage example with argument unpacking

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

parent.get_data_quality_metrics(**kwargs)

1. See GetDataQualityMetricsRequestRequestTypeDef

get_feedback

Get feedback for an anomaly group.

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

# get_feedback method definition

def get_feedback(
    self,
    *,
    AnomalyDetectorArn: str,
    AnomalyGroupTimeSeriesFeedback: AnomalyGroupTimeSeriesTypeDef,  # (1)
    MaxResults: int = ...,
    NextToken: str = ...,
) -> GetFeedbackResponseTypeDef:  # (2)
    ...

1. See AnomalyGroupTimeSeriesTypeDef
2. See GetFeedbackResponseTypeDef

# get_feedback method usage example with argument unpacking

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

parent.get_feedback(**kwargs)

1. See GetFeedbackRequestRequestTypeDef

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

# get_sample_data method definition

def get_sample_data(
    self,
    *,
    S3SourceConfig: SampleDataS3SourceConfigTypeDef = ...,  # (1)
) -> GetSampleDataResponseTypeDef:  # (2)
    ...

1. See SampleDataS3SourceConfigTypeDef
2. See GetSampleDataResponseTypeDef

# get_sample_data method usage example with argument unpacking

kwargs: GetSampleDataRequestRequestTypeDef = {  # (1)
    "S3SourceConfig": ...,
}

parent.get_sample_data(**kwargs)

1. See GetSampleDataRequestRequestTypeDef

list_alerts

Lists the alerts attached to a detector.

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

# list_alerts method definition

def list_alerts(
    self,
    *,
    AnomalyDetectorArn: str = ...,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListAlertsResponseTypeDef:  # (1)
    ...

1. See ListAlertsResponseTypeDef

# list_alerts method usage example with argument unpacking

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

parent.list_alerts(**kwargs)

1. See ListAlertsRequestRequestTypeDef

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

# list_anomaly_detectors method definition

def list_anomaly_detectors(
    self,
    *,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListAnomalyDetectorsResponseTypeDef:  # (1)
    ...

1. See ListAnomalyDetectorsResponseTypeDef

# list_anomaly_detectors method usage example with argument unpacking

kwargs: ListAnomalyDetectorsRequestRequestTypeDef = {  # (1)
    "MaxResults": ...,
}

parent.list_anomaly_detectors(**kwargs)

1. See ListAnomalyDetectorsRequestRequestTypeDef

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

# list_anomaly_group_related_metrics method definition

def list_anomaly_group_related_metrics(
    self,
    *,
    AnomalyDetectorArn: str,
    AnomalyGroupId: str,
    RelationshipTypeFilter: RelationshipTypeType = ...,  # (1)
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListAnomalyGroupRelatedMetricsResponseTypeDef:  # (2)
    ...

1. See RelationshipTypeType
2. See ListAnomalyGroupRelatedMetricsResponseTypeDef

# list_anomaly_group_related_metrics method usage example with argument unpacking

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

parent.list_anomaly_group_related_metrics(**kwargs)

1. See ListAnomalyGroupRelatedMetricsRequestRequestTypeDef

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

# list_anomaly_group_summaries method definition

def list_anomaly_group_summaries(
    self,
    *,
    AnomalyDetectorArn: str,
    SensitivityThreshold: int,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListAnomalyGroupSummariesResponseTypeDef:  # (1)
    ...

1. See ListAnomalyGroupSummariesResponseTypeDef

# list_anomaly_group_summaries method usage example with argument unpacking

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

parent.list_anomaly_group_summaries(**kwargs)

1. See ListAnomalyGroupSummariesRequestRequestTypeDef

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

# list_anomaly_group_time_series method definition

def list_anomaly_group_time_series(
    self,
    *,
    AnomalyDetectorArn: str,
    AnomalyGroupId: str,
    MetricName: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListAnomalyGroupTimeSeriesResponseTypeDef:  # (1)
    ...

1. See ListAnomalyGroupTimeSeriesResponseTypeDef

# list_anomaly_group_time_series method usage example with argument unpacking

kwargs: ListAnomalyGroupTimeSeriesRequestRequestTypeDef = {  # (1)
    "AnomalyDetectorArn": ...,
    "AnomalyGroupId": ...,
    "MetricName": ...,
}

parent.list_anomaly_group_time_series(**kwargs)

1. See ListAnomalyGroupTimeSeriesRequestRequestTypeDef

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

# list_metric_sets method definition

def list_metric_sets(
    self,
    *,
    AnomalyDetectorArn: str = ...,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListMetricSetsResponseTypeDef:  # (1)
    ...

1. See ListMetricSetsResponseTypeDef

# list_metric_sets method usage example with argument unpacking

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

parent.list_metric_sets(**kwargs)

1. See ListMetricSetsRequestRequestTypeDef

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

# list_tags_for_resource method definition

def list_tags_for_resource(
    self,
    *,
    ResourceArn: str,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...

1. See ListTagsForResourceResponseTypeDef

# list_tags_for_resource method usage example with argument unpacking

kwargs: ListTagsForResourceRequestRequestTypeDef = {  # (1)
    "ResourceArn": ...,
}

parent.list_tags_for_resource(**kwargs)

1. See ListTagsForResourceRequestRequestTypeDef

put_feedback

Add feedback for an anomalous metric.

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

# put_feedback method definition

def put_feedback(
    self,
    *,
    AnomalyDetectorArn: str,
    AnomalyGroupTimeSeriesFeedback: AnomalyGroupTimeSeriesFeedbackTypeDef,  # (1)
) -> Dict[str, Any]:
    ...

1. See AnomalyGroupTimeSeriesFeedbackTypeDef

# put_feedback method usage example with argument unpacking

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

parent.put_feedback(**kwargs)

1. See PutFeedbackRequestRequestTypeDef

tag_resource

Adds tags to a detector, dataset, or alert.

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

# tag_resource method definition

def tag_resource(
    self,
    *,
    ResourceArn: str,
    Tags: Mapping[str, str],
) -> Dict[str, Any]:
    ...

# tag_resource method usage example with argument unpacking

kwargs: TagResourceRequestRequestTypeDef = {  # (1)
    "ResourceArn": ...,
    "Tags": ...,
}

parent.tag_resource(**kwargs)

1. See TagResourceRequestRequestTypeDef

untag_resource

Removes tags from a detector, dataset, or alert.

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

# untag_resource method definition

def untag_resource(
    self,
    *,
    ResourceArn: str,
    TagKeys: Sequence[str],
) -> Dict[str, Any]:
    ...

# untag_resource method usage example with argument unpacking

kwargs: UntagResourceRequestRequestTypeDef = {  # (1)
    "ResourceArn": ...,
    "TagKeys": ...,
}

parent.untag_resource(**kwargs)

1. See UntagResourceRequestRequestTypeDef

update_alert

Make changes to an existing alert.

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

# update_alert method definition

def update_alert(
    self,
    *,
    AlertArn: str,
    AlertDescription: str = ...,
    AlertSensitivityThreshold: int = ...,
    Action: ActionTypeDef = ...,  # (1)
    AlertFilters: AlertFiltersTypeDef = ...,  # (2)
) -> UpdateAlertResponseTypeDef:  # (3)
    ...

1. See ActionTypeDef
2. See AlertFiltersTypeDef
3. See UpdateAlertResponseTypeDef

# update_alert method usage example with argument unpacking

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

parent.update_alert(**kwargs)

1. See UpdateAlertRequestRequestTypeDef

update_anomaly_detector

Updates a detector.

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

# update_anomaly_detector method definition

def update_anomaly_detector(
    self,
    *,
    AnomalyDetectorArn: str,
    KmsKeyArn: str = ...,
    AnomalyDetectorDescription: str = ...,
    AnomalyDetectorConfig: AnomalyDetectorConfigTypeDef = ...,  # (1)
) -> UpdateAnomalyDetectorResponseTypeDef:  # (2)
    ...

1. See AnomalyDetectorConfigTypeDef
2. See UpdateAnomalyDetectorResponseTypeDef

# update_anomaly_detector method usage example with argument unpacking

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

parent.update_anomaly_detector(**kwargs)

1. See UpdateAnomalyDetectorRequestRequestTypeDef

update_metric_set

Updates a dataset.

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

# update_metric_set method definition

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)
    ...

1. See MetricTypeDef
2. See TimestampColumnTypeDef
3. See FrequencyType
4. See MetricSourceTypeDef
5. See MetricSetDimensionFilterTypeDef
6. See UpdateMetricSetResponseTypeDef

# update_metric_set method usage example with argument unpacking

kwargs: UpdateMetricSetRequestRequestTypeDef = {  # (1)
    "MetricSetArn": ...,
}

parent.update_metric_set(**kwargs)

1. See UpdateMetricSetRequestRequestTypeDef