Struct Client 

pub struct Client { /* private fields */ }

Client for Amazon Lookout for Metrics

Client for invoking operations on Amazon Lookout for Metrics. Each operation on Amazon Lookout for Metrics is a method on this this struct. .send() MUST be invoked on the generated operations to dispatch the request to the service.

Constructing a Client

A Config is required to construct a client. For most use cases, the aws-config crate should be used to automatically resolve this config using aws_config::load_from_env(), since this will resolve an SdkConfig which can be shared across multiple different AWS SDK clients. This config resolution process can be customized by calling aws_config::from_env() instead, which returns a ConfigLoader that uses the builder pattern to customize the default config.

In the simplest case, creating a client looks as follows:

let config = aws_config::load_from_env().await;
let client = aws_sdk_lookoutmetrics::Client::new(&config);

Occasionally, SDKs may have additional service-specific values that can be set on the Config that is absent from SdkConfig, or slightly different settings for a specific client may be desired. The Builder struct implements From<&SdkConfig>, so setting these specific settings can be done as follows:

let sdk_config = ::aws_config::load_from_env().await;
let config = aws_sdk_lookoutmetrics::config::Builder::from(&sdk_config)
    .some_service_specific_setting("value")
    .build();

See the aws-config docs and Config for more information on customizing configuration.

Note: Client construction is expensive due to connection thread pool initialization, and should be done once at application start-up.

Using the Client

A client has a function for every operation that can be performed by the service. For example, the ActivateAnomalyDetector operation has a Client::activate_anomaly_detector, function which returns a builder for that operation. The fluent builder ultimately has a send() function that returns an async future that returns a result, as illustrated below:

let result = client.activate_anomaly_detector()
    .anomaly_detector_arn("example")
    .send()
    .await;

The underlying HTTP requests that get made by this can be modified with the customize_operation function on the fluent builder. See the customize module for more information.

Implementations

impl Client

pub fn activate_anomaly_detector(&self) -> ActivateAnomalyDetectorFluentBuilder

Constructs a fluent builder for the ActivateAnomalyDetector operation.

• The fluent builder is configurable:
  • anomaly_detector_arn(impl Into<String>) / set_anomaly_detector_arn(Option<String>):
    required: true
    

    The ARN of the anomaly detector.

    
    
• On success, responds with ActivateAnomalyDetectorOutput
• On failure, responds with SdkError<ActivateAnomalyDetectorError>

impl Client

pub fn back_test_anomaly_detector(&self) -> BackTestAnomalyDetectorFluentBuilder

Constructs a fluent builder for the BackTestAnomalyDetector operation.

• The fluent builder is configurable:
  • anomaly_detector_arn(impl Into<String>) / set_anomaly_detector_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the anomaly detector.

    
    
• On success, responds with BackTestAnomalyDetectorOutput
• On failure, responds with SdkError<BackTestAnomalyDetectorError>

impl Client

pub fn create_alert(&self) -> CreateAlertFluentBuilder

Constructs a fluent builder for the CreateAlert operation.

• The fluent builder is configurable:
  • alert_name(impl Into<String>) / set_alert_name(Option<String>):
    required: true
    

    The name of the alert.

    
    
  • alert_sensitivity_threshold(i32) / set_alert_sensitivity_threshold(Option<i32>):
    required: false
    

    An integer from 0 to 100 specifying the alert sensitivity threshold.

    
    
  • alert_description(impl Into<String>) / set_alert_description(Option<String>):
    required: false
    

    A description of the alert.

    
    
  • anomaly_detector_arn(impl Into<String>) / set_anomaly_detector_arn(Option<String>):
    required: true
    

    The ARN of the detector to which the alert is attached.

    
    
  • action(Action) / set_action(Option<Action>):
    required: true
    

    Action that will be triggered when there is an alert.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    A list of tags to apply to the alert.

    
    
  • alert_filters(AlertFilters) / set_alert_filters(Option<AlertFilters>):
    required: false
    

    The configuration of the alert filters, containing MetricList and DimensionFilterList.

    
    
• On success, responds with CreateAlertOutput with field(s):
  • alert_arn(Option<String>):

    The ARN of the alert.

• On failure, responds with SdkError<CreateAlertError>

impl Client

pub fn create_anomaly_detector(&self) -> CreateAnomalyDetectorFluentBuilder

Constructs a fluent builder for the CreateAnomalyDetector operation.

• The fluent builder is configurable:
  • anomaly_detector_name(impl Into<String>) / set_anomaly_detector_name(Option<String>):
    required: true
    

    The name of the detector.

    
    
  • anomaly_detector_description(impl Into<String>) / set_anomaly_detector_description(Option<String>):
    required: false
    

    A description of the detector.

    
    
  • anomaly_detector_config(AnomalyDetectorConfig) / set_anomaly_detector_config(Option<AnomalyDetectorConfig>):
    required: true
    

    Contains information about the configuration of the anomaly detector.

    
    
  • kms_key_arn(impl Into<String>) / set_kms_key_arn(Option<String>):
    required: false
    

    The ARN of the KMS key to use to encrypt your data.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    A list of tags to apply to the anomaly detector.

    
    
• On success, responds with CreateAnomalyDetectorOutput with field(s):
  • anomaly_detector_arn(Option<String>):

    The ARN of the detector.

• On failure, responds with SdkError<CreateAnomalyDetectorError>

impl Client

pub fn create_metric_set(&self) -> CreateMetricSetFluentBuilder

Constructs a fluent builder for the CreateMetricSet operation.

• The fluent builder is configurable:
  • anomaly_detector_arn(impl Into<String>) / set_anomaly_detector_arn(Option<String>):
    required: true
    

    The ARN of the anomaly detector that will use the dataset.

    
    
  • metric_set_name(impl Into<String>) / set_metric_set_name(Option<String>):
    required: true
    

    The name of the dataset.

    
    
  • metric_set_description(impl Into<String>) / set_metric_set_description(Option<String>):
    required: false
    

    A description of the dataset you are creating.

    
    
  • metric_list(Metric) / set_metric_list(Option<Vec::<Metric>>):
    required: true
    

    A list of metrics that the dataset will contain.

    
    
  • offset(i32) / set_offset(Option<i32>):
    required: false
    

    After an interval ends, the amount of seconds that the detector waits before importing data. Offset is only supported for S3, Redshift, Athena and datasources.

    
    
  • timestamp_column(TimestampColumn) / set_timestamp_column(Option<TimestampColumn>):
    required: false
    

    Contains information about the column used for tracking time in your source data.

    
    
  • dimension_list(impl Into<String>) / set_dimension_list(Option<Vec::<String>>):
    required: false
    

    A list of the fields you want to treat as dimensions.

    
    
  • metric_set_frequency(Frequency) / set_metric_set_frequency(Option<Frequency>):
    required: false
    

    The frequency with which the source data will be analyzed for anomalies.

    
    
  • metric_source(MetricSource) / set_metric_source(Option<MetricSource>):
    required: true
    

    Contains information about how the source data should be interpreted.

    
    
  • timezone(impl Into<String>) / set_timezone(Option<String>):
    required: false
    

    The time zone in which your source data was recorded.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    A list of tags to apply to the dataset.

    
    
  • dimension_filter_list(MetricSetDimensionFilter) / set_dimension_filter_list(Option<Vec::<MetricSetDimensionFilter>>):
    required: false
    

    A list of filters that specify which data is kept for anomaly detection.

    
    
• On success, responds with CreateMetricSetOutput with field(s):
  • metric_set_arn(Option<String>):

    The ARN of the dataset.

• On failure, responds with SdkError<CreateMetricSetError>

impl Client

pub fn deactivate_anomaly_detector( &self, ) -> DeactivateAnomalyDetectorFluentBuilder

Constructs a fluent builder for the DeactivateAnomalyDetector operation.

• The fluent builder is configurable:
  • anomaly_detector_arn(impl Into<String>) / set_anomaly_detector_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the anomaly detector.

    
    
• On success, responds with DeactivateAnomalyDetectorOutput
• On failure, responds with SdkError<DeactivateAnomalyDetectorError>

impl Client

pub fn delete_alert(&self) -> DeleteAlertFluentBuilder

Constructs a fluent builder for the DeleteAlert operation.

• The fluent builder is configurable:
  • alert_arn(impl Into<String>) / set_alert_arn(Option<String>):
    required: true
    

    The ARN of the alert to delete.

    
    
• On success, responds with DeleteAlertOutput
• On failure, responds with SdkError<DeleteAlertError>

impl Client

pub fn delete_anomaly_detector(&self) -> DeleteAnomalyDetectorFluentBuilder

Constructs a fluent builder for the DeleteAnomalyDetector operation.

• The fluent builder is configurable:
  • anomaly_detector_arn(impl Into<String>) / set_anomaly_detector_arn(Option<String>):
    required: true
    

    The ARN of the detector to delete.

    
    
• On success, responds with DeleteAnomalyDetectorOutput
• On failure, responds with SdkError<DeleteAnomalyDetectorError>

impl Client

pub fn describe_alert(&self) -> DescribeAlertFluentBuilder

Constructs a fluent builder for the DescribeAlert operation.

• The fluent builder is configurable:
  • alert_arn(impl Into<String>) / set_alert_arn(Option<String>):
    required: true
    

    The ARN of the alert to describe.

    
    
• On success, responds with DescribeAlertOutput with field(s):
  • alert(Option<Alert>):

    Contains information about an alert.

• On failure, responds with SdkError<DescribeAlertError>

impl Client

pub fn describe_anomaly_detection_executions( &self, ) -> DescribeAnomalyDetectionExecutionsFluentBuilder

Constructs a fluent builder for the DescribeAnomalyDetectionExecutions operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • anomaly_detector_arn(impl Into<String>) / set_anomaly_detector_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the anomaly detector.

    
    
  • timestamp(impl Into<String>) / set_timestamp(Option<String>):
    required: false
    

    The timestamp of the anomaly detection job.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The number of items to return in the response.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    Specify the pagination token that’s returned by a previous request to retrieve the next page of results.

    
    
• On success, responds with DescribeAnomalyDetectionExecutionsOutput with field(s):
  • execution_list(Option<Vec::<ExecutionStatus>>):

    A list of detection jobs.

  • next_token(Option<String>):

    The pagination token that’s included if more results are available.

• On failure, responds with SdkError<DescribeAnomalyDetectionExecutionsError>

impl Client

pub fn describe_anomaly_detector(&self) -> DescribeAnomalyDetectorFluentBuilder

Constructs a fluent builder for the DescribeAnomalyDetector operation.

• The fluent builder is configurable:
  • anomaly_detector_arn(impl Into<String>) / set_anomaly_detector_arn(Option<String>):
    required: true
    

    The ARN of the detector to describe.

    
    
• On success, responds with DescribeAnomalyDetectorOutput with field(s):
  • anomaly_detector_arn(Option<String>):

    The ARN of the detector.

  • anomaly_detector_name(Option<String>):

    The name of the detector.

  • anomaly_detector_description(Option<String>):

    A description of the detector.

  • anomaly_detector_config(Option<AnomalyDetectorConfigSummary>):

    Contains information about the detector’s configuration.

  • creation_time(Option<DateTime>):

    The time at which the detector was created.

  • last_modification_time(Option<DateTime>):

    The time at which the detector was last modified.

  • status(Option<AnomalyDetectorStatus>):

    The status of the detector.

  • failure_reason(Option<String>):

    The reason that the detector failed.

  • kms_key_arn(Option<String>):

    The ARN of the KMS key to use to encrypt your data.

  • failure_type(Option<AnomalyDetectorFailureType>):

    The process that caused the detector to fail.

• On failure, responds with SdkError<DescribeAnomalyDetectorError>

impl Client

pub fn describe_metric_set(&self) -> DescribeMetricSetFluentBuilder

Constructs a fluent builder for the DescribeMetricSet operation.

• The fluent builder is configurable:
  • metric_set_arn(impl Into<String>) / set_metric_set_arn(Option<String>):
    required: true
    

    The ARN of the dataset.

    
    
• On success, responds with DescribeMetricSetOutput with field(s):
  • metric_set_arn(Option<String>):

    The ARN of the dataset.

  • anomaly_detector_arn(Option<String>):

    The ARN of the detector that contains the dataset.

  • metric_set_name(Option<String>):

    The name of the dataset.

  • metric_set_description(Option<String>):

    The dataset’s description.

  • creation_time(Option<DateTime>):

    The time at which the dataset was created.

  • last_modification_time(Option<DateTime>):

    The time at which the dataset was last modified.

  • offset(Option<i32>):

    After an interval ends, the amount of seconds that the detector waits before importing data. Offset is only supported for S3, Redshift, Athena and datasources.

  • metric_list(Option<Vec::<Metric>>):

    A list of the metrics defined by the dataset.

  • timestamp_column(Option<TimestampColumn>):

    Contains information about the column used for tracking time in your source data.

  • dimension_list(Option<Vec::<String>>):

    A list of the dimensions chosen for analysis.

  • metric_set_frequency(Option<Frequency>):

    The interval at which the data will be analyzed for anomalies.

  • timezone(Option<String>):

    The time zone in which the dataset’s data was recorded.

  • metric_source(Option<MetricSource>):

    Contains information about the dataset’s source data.

  • dimension_filter_list(Option<Vec::<MetricSetDimensionFilter>>):

    The dimensions and their values that were used to filter the dataset.

• On failure, responds with SdkError<DescribeMetricSetError>

impl Client

pub fn detect_metric_set_config(&self) -> DetectMetricSetConfigFluentBuilder

Constructs a fluent builder for the DetectMetricSetConfig operation.

• The fluent builder is configurable:
  • anomaly_detector_arn(impl Into<String>) / set_anomaly_detector_arn(Option<String>):
    required: true
    

    An anomaly detector ARN.

    
    
  • auto_detection_metric_source(AutoDetectionMetricSource) / set_auto_detection_metric_source(Option<AutoDetectionMetricSource>):
    required: true
    

    A data source.

    
    
• On success, responds with DetectMetricSetConfigOutput with field(s):
  • detected_metric_set_config(Option<DetectedMetricSetConfig>):

    The inferred dataset configuration for the datasource.

• On failure, responds with SdkError<DetectMetricSetConfigError>

impl Client

pub fn get_anomaly_group(&self) -> GetAnomalyGroupFluentBuilder

Constructs a fluent builder for the GetAnomalyGroup operation.

• The fluent builder is configurable:
  • anomaly_group_id(impl Into<String>) / set_anomaly_group_id(Option<String>):
    required: true
    

    The ID of the anomaly group.

    
    
  • anomaly_detector_arn(impl Into<String>) / set_anomaly_detector_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the anomaly detector.

    
    
• On success, responds with GetAnomalyGroupOutput with field(s):
  • anomaly_group(Option<AnomalyGroup>):

    Details about the anomaly group.

• On failure, responds with SdkError<GetAnomalyGroupError>

impl Client

pub fn get_data_quality_metrics(&self) -> GetDataQualityMetricsFluentBuilder

Constructs a fluent builder for the GetDataQualityMetrics operation.

• The fluent builder is configurable:
  • anomaly_detector_arn(impl Into<String>) / set_anomaly_detector_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the anomaly detector that you want to investigate.

    
    
  • metric_set_arn(impl Into<String>) / set_metric_set_arn(Option<String>):
    required: false
    

    The Amazon Resource Name (ARN) of a specific data quality metric set.

    
    
• On success, responds with GetDataQualityMetricsOutput with field(s):
  • anomaly_detector_data_quality_metric_list(Option<Vec::<AnomalyDetectorDataQualityMetric>>):

    A list of the data quality metrics for the AnomalyDetectorArn that you requested.

• On failure, responds with SdkError<GetDataQualityMetricsError>

impl Client

pub fn get_feedback(&self) -> GetFeedbackFluentBuilder

Constructs a fluent builder for the GetFeedback operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • anomaly_detector_arn(impl Into<String>) / set_anomaly_detector_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the anomaly detector.

    
    
  • anomaly_group_time_series_feedback(AnomalyGroupTimeSeries) / set_anomaly_group_time_series_feedback(Option<AnomalyGroupTimeSeries>):
    required: true
    

    The anomalous metric and group ID.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    Specify the pagination token that’s returned by a previous request to retrieve the next page of results.

    
    
• On success, responds with GetFeedbackOutput with field(s):
  • anomaly_group_time_series_feedback(Option<Vec::<TimeSeriesFeedback>>):

    Feedback for an anomalous metric.

  • next_token(Option<String>):

    The pagination token that’s included if more results are available.

• On failure, responds with SdkError<GetFeedbackError>

impl Client

pub fn get_sample_data(&self) -> GetSampleDataFluentBuilder

Constructs a fluent builder for the GetSampleData operation.

• The fluent builder is configurable:
  • s3_source_config(SampleDataS3SourceConfig) / set_s3_source_config(Option<SampleDataS3SourceConfig>):
    required: false
    

    A datasource bucket in Amazon S3.

    
    
• On success, responds with GetSampleDataOutput with field(s):
  • header_values(Option<Vec::<String>>):

    A list of header labels for the records.

  • sample_rows(Option<Vec::<Vec::<String>>>):

    A list of records.

• On failure, responds with SdkError<GetSampleDataError>

impl Client

pub fn list_alerts(&self) -> ListAlertsFluentBuilder

Constructs a fluent builder for the ListAlerts operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • anomaly_detector_arn(impl Into<String>) / set_anomaly_detector_arn(Option<String>):
    required: false
    

    The ARN of the alert’s detector.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    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.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results that will be displayed by the request.

    
    
• On success, responds with ListAlertsOutput with field(s):
  • alert_summary_list(Option<Vec::<AlertSummary>>):

    Contains information about an alert.

  • next_token(Option<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.

• On failure, responds with SdkError<ListAlertsError>

impl Client

pub fn list_anomaly_detectors(&self) -> ListAnomalyDetectorsFluentBuilder

Constructs a fluent builder for the ListAnomalyDetectors operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    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.

    
    
• On success, responds with ListAnomalyDetectorsOutput with field(s):
  • anomaly_detector_summary_list(Option<Vec::<AnomalyDetectorSummary>>):

    A list of anomaly detectors in the account in the current region.

  • next_token(Option<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.

• On failure, responds with SdkError<ListAnomalyDetectorsError>

impl Client

pub fn list_anomaly_group_related_metrics( &self, ) -> ListAnomalyGroupRelatedMetricsFluentBuilder

Constructs a fluent builder for the ListAnomalyGroupRelatedMetrics operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • anomaly_detector_arn(impl Into<String>) / set_anomaly_detector_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the anomaly detector.

    
    
  • anomaly_group_id(impl Into<String>) / set_anomaly_group_id(Option<String>):
    required: true
    

    The ID of the anomaly group.

    
    
  • relationship_type_filter(RelationshipType) / set_relationship_type_filter(Option<RelationshipType>):
    required: false
    

    Filter for potential causes (CAUSE_OF_INPUT_ANOMALY_GROUP) or downstream effects (EFFECT_OF_INPUT_ANOMALY_GROUP) of the anomaly group.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    Specify the pagination token that’s returned by a previous request to retrieve the next page of results.

    
    
• On success, responds with ListAnomalyGroupRelatedMetricsOutput with field(s):
  • inter_metric_impact_list(Option<Vec::<InterMetricImpactDetails>>):

    Aggregated details about the measures contributing to the anomaly group, and the measures potentially impacted by the anomaly group.

  • next_token(Option<String>):

    The pagination token that’s included if more results are available.

• On failure, responds with SdkError<ListAnomalyGroupRelatedMetricsError>

impl Client

pub fn list_anomaly_group_summaries( &self, ) -> ListAnomalyGroupSummariesFluentBuilder

Constructs a fluent builder for the ListAnomalyGroupSummaries operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • anomaly_detector_arn(impl Into<String>) / set_anomaly_detector_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the anomaly detector.

    
    
  • sensitivity_threshold(i32) / set_sensitivity_threshold(Option<i32>):
    required: true
    

    The minimum severity score for inclusion in the output.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    Specify the pagination token that’s returned by a previous request to retrieve the next page of results.

    
    
• On success, responds with ListAnomalyGroupSummariesOutput with field(s):
  • anomaly_group_summary_list(Option<Vec::<AnomalyGroupSummary>>):

    A list of anomaly group summaries.

  • anomaly_group_statistics(Option<AnomalyGroupStatistics>):

    Aggregated details about the anomaly groups.

  • next_token(Option<String>):

    The pagination token that’s included if more results are available.

• On failure, responds with SdkError<ListAnomalyGroupSummariesError>

impl Client

pub fn list_anomaly_group_time_series( &self, ) -> ListAnomalyGroupTimeSeriesFluentBuilder

Constructs a fluent builder for the ListAnomalyGroupTimeSeries operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • anomaly_detector_arn(impl Into<String>) / set_anomaly_detector_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the anomaly detector.

    
    
  • anomaly_group_id(impl Into<String>) / set_anomaly_group_id(Option<String>):
    required: true
    

    The ID of the anomaly group.

    
    
  • metric_name(impl Into<String>) / set_metric_name(Option<String>):
    required: true
    

    The name of the measure field.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    Specify the pagination token that’s returned by a previous request to retrieve the next page of results.

    
    
• On success, responds with ListAnomalyGroupTimeSeriesOutput with field(s):
  • anomaly_group_id(Option<String>):

    The ID of the anomaly group.

  • metric_name(Option<String>):

    The name of the measure field.

  • timestamp_list(Option<Vec::<String>>):

    Timestamps for the anomalous metrics.

  • next_token(Option<String>):

    The pagination token that’s included if more results are available.

  • time_series_list(Option<Vec::<TimeSeries>>):

    A list of anomalous metrics.

• On failure, responds with SdkError<ListAnomalyGroupTimeSeriesError>

impl Client

pub fn list_metric_sets(&self) -> ListMetricSetsFluentBuilder

Constructs a fluent builder for the ListMetricSets operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • anomaly_detector_arn(impl Into<String>) / set_anomaly_detector_arn(Option<String>):
    required: false
    

    The ARN of the anomaly detector containing the metrics sets to list.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    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.

    
    
• On success, responds with ListMetricSetsOutput with field(s):
  • metric_set_summary_list(Option<Vec::<MetricSetSummary>>):

    A list of the datasets in the AWS Region, with configuration details for each.

  • next_token(Option<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.

• On failure, responds with SdkError<ListMetricSetsError>

impl Client

pub fn list_tags_for_resource(&self) -> ListTagsForResourceFluentBuilder

Constructs a fluent builder for the ListTagsForResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The resource’s Amazon Resource Name (ARN).

    
    
• On success, responds with ListTagsForResourceOutput with field(s):
  • tags(Option<HashMap::<String, String>>):

    The resource’s tags.

• On failure, responds with SdkError<ListTagsForResourceError>

impl Client

pub fn put_feedback(&self) -> PutFeedbackFluentBuilder

Constructs a fluent builder for the PutFeedback operation.

• The fluent builder is configurable:
  • anomaly_detector_arn(impl Into<String>) / set_anomaly_detector_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the anomaly detector.

    
    
  • anomaly_group_time_series_feedback(AnomalyGroupTimeSeriesFeedback) / set_anomaly_group_time_series_feedback(Option<AnomalyGroupTimeSeriesFeedback>):
    required: true
    

    Feedback for an anomalous metric.

    
    
• On success, responds with PutFeedbackOutput
• On failure, responds with SdkError<PutFeedbackError>

impl Client

pub fn tag_resource(&self) -> TagResourceFluentBuilder

Constructs a fluent builder for the TagResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The resource’s Amazon Resource Name (ARN).

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: true
    

    Tags to apply to the resource. Tag keys and values can contain letters, numbers, spaces, and the following symbols: _.:/=+@-

    
    
• On success, responds with TagResourceOutput
• On failure, responds with SdkError<TagResourceError>

impl Client

pub fn untag_resource(&self) -> UntagResourceFluentBuilder

Constructs a fluent builder for the UntagResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The resource’s Amazon Resource Name (ARN).

    
    
  • tag_keys(impl Into<String>) / set_tag_keys(Option<Vec::<String>>):
    required: true
    

    Keys to remove from the resource’s tags.

    
    
• On success, responds with UntagResourceOutput
• On failure, responds with SdkError<UntagResourceError>

impl Client

pub fn update_alert(&self) -> UpdateAlertFluentBuilder

Constructs a fluent builder for the UpdateAlert operation.

• The fluent builder is configurable:
  • alert_arn(impl Into<String>) / set_alert_arn(Option<String>):
    required: true
    

    The ARN of the alert to update.

    
    
  • alert_description(impl Into<String>) / set_alert_description(Option<String>):
    required: false
    

    A description of the alert.

    
    
  • alert_sensitivity_threshold(i32) / set_alert_sensitivity_threshold(Option<i32>):
    required: false
    

    An integer from 0 to 100 specifying the alert sensitivity threshold.

    
    
  • action(Action) / set_action(Option<Action>):
    required: false
    

    Action that will be triggered when there is an alert.

    
    
  • alert_filters(AlertFilters) / set_alert_filters(Option<AlertFilters>):
    required: false
    

    The configuration of the alert filters, containing MetricList and DimensionFilterList.

    
    
• On success, responds with UpdateAlertOutput with field(s):
  • alert_arn(Option<String>):

    The ARN of the updated alert.

• On failure, responds with SdkError<UpdateAlertError>

impl Client

pub fn update_anomaly_detector(&self) -> UpdateAnomalyDetectorFluentBuilder

Constructs a fluent builder for the UpdateAnomalyDetector operation.

• The fluent builder is configurable:
  • anomaly_detector_arn(impl Into<String>) / set_anomaly_detector_arn(Option<String>):
    required: true
    

    The ARN of the detector to update.

    
    
  • kms_key_arn(impl Into<String>) / set_kms_key_arn(Option<String>):
    required: false
    

    The Amazon Resource Name (ARN) of an AWS KMS encryption key.

    
    
  • anomaly_detector_description(impl Into<String>) / set_anomaly_detector_description(Option<String>):
    required: false
    

    The updated detector description.

    
    
  • anomaly_detector_config(AnomalyDetectorConfig) / set_anomaly_detector_config(Option<AnomalyDetectorConfig>):
    required: false
    

    Contains information about the configuration to which the detector will be updated.

    
    
• On success, responds with UpdateAnomalyDetectorOutput with field(s):
  • anomaly_detector_arn(Option<String>):

    The ARN of the updated detector.

• On failure, responds with SdkError<UpdateAnomalyDetectorError>

impl Client

pub fn update_metric_set(&self) -> UpdateMetricSetFluentBuilder

Constructs a fluent builder for the UpdateMetricSet operation.

• The fluent builder is configurable:
  • metric_set_arn(impl Into<String>) / set_metric_set_arn(Option<String>):
    required: true
    

    The ARN of the dataset to update.

    
    
  • metric_set_description(impl Into<String>) / set_metric_set_description(Option<String>):
    required: false
    

    The dataset’s description.

    
    
  • metric_list(Metric) / set_metric_list(Option<Vec::<Metric>>):
    required: false
    

    The metric list.

    
    
  • offset(i32) / set_offset(Option<i32>):
    required: false
    

    After an interval ends, the amount of seconds that the detector waits before importing data. Offset is only supported for S3, Redshift, Athena and datasources.

    
    
  • timestamp_column(TimestampColumn) / set_timestamp_column(Option<TimestampColumn>):
    required: false
    

    The timestamp column.

    
    
  • dimension_list(impl Into<String>) / set_dimension_list(Option<Vec::<String>>):
    required: false
    

    The dimension list.

    
    
  • metric_set_frequency(Frequency) / set_metric_set_frequency(Option<Frequency>):
    required: false
    

    The dataset’s interval.

    
    
  • metric_source(MetricSource) / set_metric_source(Option<MetricSource>):
    required: false
    

    Contains information about source data used to generate metrics.

    
    
  • dimension_filter_list(MetricSetDimensionFilter) / set_dimension_filter_list(Option<Vec::<MetricSetDimensionFilter>>):
    required: false
    

    Describes a list of filters for choosing specific dimensions and specific values. Each filter consists of the dimension and one of its values that you want to include. When multiple dimensions or values are specified, the dimensions are joined with an AND operation and the values are joined with an OR operation.

    
    
• On success, responds with UpdateMetricSetOutput with field(s):
  • metric_set_arn(Option<String>):

    The ARN of the dataset.

• On failure, responds with SdkError<UpdateMetricSetError>

impl Client

pub fn from_conf(conf: Config) -> Self

Creates a new client from the service Config.

Panics

This method will panic in the following cases:

• Retries or timeouts are enabled without a sleep_impl configured.
• Identity caching is enabled without a sleep_impl and time_source configured.
• No behavior_version is provided.

The panic message for each of these will have instructions on how to resolve them.

pub fn config(&self) -> &Config

Returns the client’s configuration.

impl Client

pub fn new(sdk_config: &SdkConfig) -> Self

Creates a new client from an SDK Config.

Panics

• This method will panic if the sdk_config is missing an async sleep implementation. If you experience this panic, set the sleep_impl on the Config passed into this function to fix it.
• This method will panic if the sdk_config is missing an HTTP connector. If you experience this panic, set the http_connector on the Config passed into this function to fix it.
• This method will panic if no BehaviorVersion is provided. If you experience this panic, set behavior_version on the Config or enable the behavior-version-latest Cargo feature.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Client

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.