Struct aws_sdk_cloudwatch::client::Client

pub struct Client { /* private fields */ }

Client for Amazon CloudWatch

Client for invoking operations on Amazon CloudWatch. Each operation on Amazon CloudWatch 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_cloudwatch::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 Config 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_cloudwatch::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 DeleteAnomalyDetector operation has a Client::delete_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.delete_anomaly_detector()
    .namespace("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 delete_alarms(&self) -> DeleteAlarmsFluentBuilder

Constructs a fluent builder for the DeleteAlarms operation.

• The fluent builder is configurable:
  • alarm_names(impl Into<String>) / set_alarm_names(Option<Vec::<String>>):
    required: true
    

    The alarms to be deleted. Do not enclose the alarm names in quote marks.

    
    
• On success, responds with DeleteAlarmsOutput
• On failure, responds with SdkError<DeleteAlarmsError>

impl Client

pub fn delete_anomaly_detector(&self) -> DeleteAnomalyDetectorFluentBuilder

Constructs a fluent builder for the DeleteAnomalyDetector operation.

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

    The namespace associated with the anomaly detection model to delete.

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

    The metric name associated with the anomaly detection model to delete.

    
    
  • dimensions(Dimension) / set_dimensions(Option<Vec::<Dimension>>):
    required: false
    

    The metric dimensions associated with the anomaly detection model to delete.

    
    
  • stat(impl Into<String>) / set_stat(Option<String>):
    required: false
    

    The statistic associated with the anomaly detection model to delete.

    
    
  • single_metric_anomaly_detector(SingleMetricAnomalyDetector) / set_single_metric_anomaly_detector(Option<SingleMetricAnomalyDetector>):
    required: false
    

    A single metric anomaly detector to be deleted.

    When using SingleMetricAnomalyDetector, you cannot include the following parameters in the same operation:

    • Dimensions,

    • MetricName

    • Namespace

    • Stat

    • the MetricMathAnomalyDetector parameters of DeleteAnomalyDetectorInput

    Instead, specify the single metric anomaly detector attributes as part of the SingleMetricAnomalyDetector property.

    
    
  • metric_math_anomaly_detector(MetricMathAnomalyDetector) / set_metric_math_anomaly_detector(Option<MetricMathAnomalyDetector>):
    required: false
    

    The metric math anomaly detector to be deleted.

    When using MetricMathAnomalyDetector, you cannot include following parameters in the same operation:

    • Dimensions,

    • MetricName

    • Namespace

    • Stat

    • the SingleMetricAnomalyDetector parameters of DeleteAnomalyDetectorInput

    Instead, specify the metric math anomaly detector attributes as part of the MetricMathAnomalyDetector property.

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

impl Client

pub fn delete_dashboards(&self) -> DeleteDashboardsFluentBuilder

Constructs a fluent builder for the DeleteDashboards operation.

• The fluent builder is configurable:
  • dashboard_names(impl Into<String>) / set_dashboard_names(Option<Vec::<String>>):
    required: true
    

    The dashboards to be deleted. This parameter is required.

    
    
• On success, responds with DeleteDashboardsOutput
• On failure, responds with SdkError<DeleteDashboardsError>

impl Client

pub fn delete_insight_rules(&self) -> DeleteInsightRulesFluentBuilder

Constructs a fluent builder for the DeleteInsightRules operation.

• The fluent builder is configurable:
  • rule_names(impl Into<String>) / set_rule_names(Option<Vec::<String>>):
    required: true
    

    An array of the rule names to delete. If you need to find out the names of your rules, use DescribeInsightRules.

    
    
• On success, responds with DeleteInsightRulesOutput with field(s):
  • failures(Option<Vec::<PartialFailure>>):

    An array listing the rules that could not be deleted. You cannot delete built-in rules.

• On failure, responds with SdkError<DeleteInsightRulesError>

impl Client

pub fn delete_metric_stream(&self) -> DeleteMetricStreamFluentBuilder

Constructs a fluent builder for the DeleteMetricStream operation.

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

    The name of the metric stream to delete.

    
    
• On success, responds with DeleteMetricStreamOutput
• On failure, responds with SdkError<DeleteMetricStreamError>

impl Client

pub fn describe_alarm_history(&self) -> DescribeAlarmHistoryFluentBuilder

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

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

    The name of the alarm.

    
    
  • alarm_types(AlarmType) / set_alarm_types(Option<Vec::<AlarmType>>):
    required: false
    

    Use this parameter to specify whether you want the operation to return metric alarms or composite alarms. If you omit this parameter, only metric alarms are returned.

    
    
  • history_item_type(HistoryItemType) / set_history_item_type(Option<HistoryItemType>):
    required: false
    

    The type of alarm histories to retrieve.

    
    
  • start_date(DateTime) / set_start_date(Option<DateTime>):
    required: false
    

    The starting date to retrieve alarm history.

    
    
  • end_date(DateTime) / set_end_date(Option<DateTime>):
    required: false
    

    The ending date to retrieve alarm history.

    
    
  • max_records(i32) / set_max_records(Option<i32>):
    required: false
    

    The maximum number of alarm history records to retrieve.

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

    The token returned by a previous call to indicate that there is more data available.

    
    
  • scan_by(ScanBy) / set_scan_by(Option<ScanBy>):
    required: false
    

    Specified whether to return the newest or oldest alarm history first. Specify TimestampDescending to have the newest event history returned first, and specify TimestampAscending to have the oldest history returned first.

    
    
• On success, responds with DescribeAlarmHistoryOutput with field(s):
  • alarm_history_items(Option<Vec::<AlarmHistoryItem>>):

    The alarm histories, in JSON format.

  • next_token(Option<String>):

    The token that marks the start of the next batch of returned results.

• On failure, responds with SdkError<DescribeAlarmHistoryError>

impl Client

pub fn describe_alarms(&self) -> DescribeAlarmsFluentBuilder

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

• The fluent builder is configurable:
  • alarm_names(impl Into<String>) / set_alarm_names(Option<Vec::<String>>):
    required: false
    

    The names of the alarms to retrieve information about.

    
    
  • alarm_name_prefix(impl Into<String>) / set_alarm_name_prefix(Option<String>):
    required: false
    

    An alarm name prefix. If you specify this parameter, you receive information about all alarms that have names that start with this prefix.

    If this parameter is specified, you cannot specify AlarmNames.

    
    
  • alarm_types(AlarmType) / set_alarm_types(Option<Vec::<AlarmType>>):
    required: false
    

    Use this parameter to specify whether you want the operation to return metric alarms or composite alarms. If you omit this parameter, only metric alarms are returned, even if composite alarms exist in the account.

    For example, if you omit this parameter or specify MetricAlarms, the operation returns only a list of metric alarms. It does not return any composite alarms, even if composite alarms exist in the account.

    If you specify CompositeAlarms, the operation returns only a list of composite alarms, and does not return any metric alarms.

    
    
  • children_of_alarm_name(impl Into<String>) / set_children_of_alarm_name(Option<String>):
    required: false
    

    If you use this parameter and specify the name of a composite alarm, the operation returns information about the “children” alarms of the alarm you specify. These are the metric alarms and composite alarms referenced in the AlarmRule field of the composite alarm that you specify in ChildrenOfAlarmName. Information about the composite alarm that you name in ChildrenOfAlarmName is not returned.

    If you specify ChildrenOfAlarmName, you cannot specify any other parameters in the request except for MaxRecords and NextToken. If you do so, you receive a validation error.

    Only the Alarm Name, ARN, StateValue (OK/ALARM/INSUFFICIENT_DATA), and StateUpdatedTimestamp information are returned by this operation when you use this parameter. To get complete information about these alarms, perform another DescribeAlarms operation and specify the parent alarm names in the AlarmNames parameter.

    
    
  • parents_of_alarm_name(impl Into<String>) / set_parents_of_alarm_name(Option<String>):
    required: false
    

    If you use this parameter and specify the name of a metric or composite alarm, the operation returns information about the “parent” alarms of the alarm you specify. These are the composite alarms that have AlarmRule parameters that reference the alarm named in ParentsOfAlarmName. Information about the alarm that you specify in ParentsOfAlarmName is not returned.

    If you specify ParentsOfAlarmName, you cannot specify any other parameters in the request except for MaxRecords and NextToken. If you do so, you receive a validation error.

    Only the Alarm Name and ARN are returned by this operation when you use this parameter. To get complete information about these alarms, perform another DescribeAlarms operation and specify the parent alarm names in the AlarmNames parameter.

    
    
  • state_value(StateValue) / set_state_value(Option<StateValue>):
    required: false
    

    Specify this parameter to receive information only about alarms that are currently in the state that you specify.

    
    
  • action_prefix(impl Into<String>) / set_action_prefix(Option<String>):
    required: false
    

    Use this parameter to filter the results of the operation to only those alarms that use a certain alarm action. For example, you could specify the ARN of an SNS topic to find all alarms that send notifications to that topic.

    
    
  • max_records(i32) / set_max_records(Option<i32>):
    required: false
    

    The maximum number of alarm descriptions to retrieve.

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

    The token returned by a previous call to indicate that there is more data available.

    
    
• On success, responds with DescribeAlarmsOutput with field(s):
  • composite_alarms(Option<Vec::<CompositeAlarm>>):

    The information about any composite alarms returned by the operation.

  • metric_alarms(Option<Vec::<MetricAlarm>>):

    The information about any metric alarms returned by the operation.

  • next_token(Option<String>):

    The token that marks the start of the next batch of returned results.

• On failure, responds with SdkError<DescribeAlarmsError>

impl Client

pub fn describe_alarms_for_metric(&self) -> DescribeAlarmsForMetricFluentBuilder

Constructs a fluent builder for the DescribeAlarmsForMetric operation.

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

    The name of the metric.

    
    
  • namespace(impl Into<String>) / set_namespace(Option<String>):
    required: true
    

    The namespace of the metric.

    
    
  • statistic(Statistic) / set_statistic(Option<Statistic>):
    required: false
    

    The statistic for the metric, other than percentiles. For percentile statistics, use ExtendedStatistics.

    
    
  • extended_statistic(impl Into<String>) / set_extended_statistic(Option<String>):
    required: false
    

    The percentile statistic for the metric. Specify a value between p0.0 and p100.

    
    
  • dimensions(Dimension) / set_dimensions(Option<Vec::<Dimension>>):
    required: false
    

    The dimensions associated with the metric. If the metric has any associated dimensions, you must specify them in order for the call to succeed.

    
    
  • period(i32) / set_period(Option<i32>):
    required: false
    

    The period, in seconds, over which the statistic is applied.

    
    
  • unit(StandardUnit) / set_unit(Option<StandardUnit>):
    required: false
    

    The unit for the metric.

    
    
• On success, responds with DescribeAlarmsForMetricOutput with field(s):
  • metric_alarms(Option<Vec::<MetricAlarm>>):

    The information for each alarm with the specified metric.

• On failure, responds with SdkError<DescribeAlarmsForMetricError>

impl Client

pub fn describe_anomaly_detectors( &self ) -> DescribeAnomalyDetectorsFluentBuilder

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

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

    Use the token returned by the previous operation to request the next page of results.

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

    The maximum number of results to return in one operation. The maximum value that you can specify is 100.

    To retrieve the remaining results, make another call with the returned NextToken value.

    
    
  • namespace(impl Into<String>) / set_namespace(Option<String>):
    required: false
    

    Limits the results to only the anomaly detection models that are associated with the specified namespace.

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

    Limits the results to only the anomaly detection models that are associated with the specified metric name. If there are multiple metrics with this name in different namespaces that have anomaly detection models, they’re all returned.

    
    
  • dimensions(Dimension) / set_dimensions(Option<Vec::<Dimension>>):
    required: false
    

    Limits the results to only the anomaly detection models that are associated with the specified metric dimensions. If there are multiple metrics that have these dimensions and have anomaly detection models associated, they’re all returned.

    
    
  • anomaly_detector_types(AnomalyDetectorType) / set_anomaly_detector_types(Option<Vec::<AnomalyDetectorType>>):
    required: false
    

    The anomaly detector types to request when using DescribeAnomalyDetectorsInput. If empty, defaults to SINGLE_METRIC.

    
    
• On success, responds with DescribeAnomalyDetectorsOutput with field(s):
  • anomaly_detectors(Option<Vec::<AnomalyDetector>>):

    The list of anomaly detection models returned by the operation.

  • next_token(Option<String>):

    A token that you can use in a subsequent operation to retrieve the next set of results.

• On failure, responds with SdkError<DescribeAnomalyDetectorsError>

impl Client

pub fn describe_insight_rules(&self) -> DescribeInsightRulesFluentBuilder

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

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

    Include this value, if it was returned by the previous operation, to get the next set of rules.

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

    The maximum number of results to return in one operation. If you omit this parameter, the default of 500 is used.

    
    
• On success, responds with DescribeInsightRulesOutput with field(s):
  • next_token(Option<String>):

    If this parameter is present, it is a token that marks the start of the next batch of returned results.

  • insight_rules(Option<Vec::<InsightRule>>):

    The rules returned by the operation.

• On failure, responds with SdkError<DescribeInsightRulesError>

impl Client

pub fn disable_alarm_actions(&self) -> DisableAlarmActionsFluentBuilder

Constructs a fluent builder for the DisableAlarmActions operation.

• The fluent builder is configurable:
  • alarm_names(impl Into<String>) / set_alarm_names(Option<Vec::<String>>):
    required: true
    

    The names of the alarms.

    
    
• On success, responds with DisableAlarmActionsOutput
• On failure, responds with SdkError<DisableAlarmActionsError>

impl Client

pub fn disable_insight_rules(&self) -> DisableInsightRulesFluentBuilder

Constructs a fluent builder for the DisableInsightRules operation.

• The fluent builder is configurable:
  • rule_names(impl Into<String>) / set_rule_names(Option<Vec::<String>>):
    required: true
    

    An array of the rule names to disable. If you need to find out the names of your rules, use DescribeInsightRules.

    
    
• On success, responds with DisableInsightRulesOutput with field(s):
  • failures(Option<Vec::<PartialFailure>>):

    An array listing the rules that could not be disabled. You cannot disable built-in rules.

• On failure, responds with SdkError<DisableInsightRulesError>

impl Client

pub fn enable_alarm_actions(&self) -> EnableAlarmActionsFluentBuilder

Constructs a fluent builder for the EnableAlarmActions operation.

• The fluent builder is configurable:
  • alarm_names(impl Into<String>) / set_alarm_names(Option<Vec::<String>>):
    required: true
    

    The names of the alarms.

    
    
• On success, responds with EnableAlarmActionsOutput
• On failure, responds with SdkError<EnableAlarmActionsError>

impl Client

pub fn enable_insight_rules(&self) -> EnableInsightRulesFluentBuilder

Constructs a fluent builder for the EnableInsightRules operation.

• The fluent builder is configurable:
  • rule_names(impl Into<String>) / set_rule_names(Option<Vec::<String>>):
    required: true
    

    An array of the rule names to enable. If you need to find out the names of your rules, use DescribeInsightRules.

    
    
• On success, responds with EnableInsightRulesOutput with field(s):
  • failures(Option<Vec::<PartialFailure>>):

    An array listing the rules that could not be enabled. You cannot disable or enable built-in rules.

• On failure, responds with SdkError<EnableInsightRulesError>

impl Client

pub fn get_dashboard(&self) -> GetDashboardFluentBuilder

Constructs a fluent builder for the GetDashboard operation.

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

    The name of the dashboard to be described.

    
    
• On success, responds with GetDashboardOutput with field(s):
  • dashboard_arn(Option<String>):

    The Amazon Resource Name (ARN) of the dashboard.

  • dashboard_body(Option<String>):

    The detailed information about the dashboard, including what widgets are included and their location on the dashboard. For more information about the DashboardBody syntax, see Dashboard Body Structure and Syntax.

  • dashboard_name(Option<String>):

    The name of the dashboard.

• On failure, responds with SdkError<GetDashboardError>

impl Client

pub fn get_insight_rule_report(&self) -> GetInsightRuleReportFluentBuilder

Constructs a fluent builder for the GetInsightRuleReport operation.

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

    The name of the rule that you want to see data from.

    
    
  • start_time(DateTime) / set_start_time(Option<DateTime>):
    required: true
    

    The start time of the data to use in the report. When used in a raw HTTP Query API, it is formatted as yyyy-MM-dd’T’HH:mm:ss. For example, 2019-07-01T23:59:59.

    
    
  • end_time(DateTime) / set_end_time(Option<DateTime>):
    required: true
    

    The end time of the data to use in the report. When used in a raw HTTP Query API, it is formatted as yyyy-MM-dd’T’HH:mm:ss. For example, 2019-07-01T23:59:59.

    
    
  • period(i32) / set_period(Option<i32>):
    required: true
    

    The period, in seconds, to use for the statistics in the InsightRuleMetricDatapoint results.

    
    
  • max_contributor_count(i32) / set_max_contributor_count(Option<i32>):
    required: false
    

    The maximum number of contributors to include in the report. The range is 1 to 100. If you omit this, the default of 10 is used.

    
    
  • metrics(impl Into<String>) / set_metrics(Option<Vec::<String>>):
    required: false
    

    Specifies which metrics to use for aggregation of contributor values for the report. You can specify one or more of the following metrics:

    • UniqueContributors – the number of unique contributors for each data point.

    • MaxContributorValue – the value of the top contributor for each data point. The identity of the contributor might change for each data point in the graph.

      If this rule aggregates by COUNT, the top contributor for each data point is the contributor with the most occurrences in that period. If the rule aggregates by SUM, the top contributor is the contributor with the highest sum in the log field specified by the rule’s Value, during that period.

    • SampleCount – the number of data points matched by the rule.

    • Sum – the sum of the values from all contributors during the time period represented by that data point.

    • Minimum – the minimum value from a single observation during the time period represented by that data point.

    • Maximum – the maximum value from a single observation during the time period represented by that data point.

    • Average – the average value from all contributors during the time period represented by that data point.

    
    
  • order_by(impl Into<String>) / set_order_by(Option<String>):
    required: false
    

    Determines what statistic to use to rank the contributors. Valid values are Sum and Maximum.

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

    An array of the strings used as the keys for this rule. The keys are the dimensions used to classify contributors. If the rule contains more than one key, then each unique combination of values for the keys is counted as a unique contributor.

  • aggregation_statistic(Option<String>):

    Specifies whether this rule aggregates contributor data by COUNT or SUM.

  • aggregate_value(Option<f64>):

    The sum of the values from all individual contributors that match the rule.

  • approximate_unique_count(Option<i64>):

    An approximate count of the unique contributors found by this rule in this time period.

  • contributors(Option<Vec::<InsightRuleContributor>>):

    An array of the unique contributors found by this rule in this time period. If the rule contains multiple keys, each combination of values for the keys counts as a unique contributor.

  • metric_datapoints(Option<Vec::<InsightRuleMetricDatapoint>>):

    A time series of metric data points that matches the time period in the rule request.

• On failure, responds with SdkError<GetInsightRuleReportError>

impl Client

pub fn get_metric_data(&self) -> GetMetricDataFluentBuilder

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

• The fluent builder is configurable:
  • metric_data_queries(MetricDataQuery) / set_metric_data_queries(Option<Vec::<MetricDataQuery>>):
    required: true
    

    The metric queries to be returned. A single GetMetricData call can include as many as 500 MetricDataQuery structures. Each of these structures can specify either a metric to retrieve, a Metrics Insights query, or a math expression to perform on retrieved data.

    
    
  • start_time(DateTime) / set_start_time(Option<DateTime>):
    required: true
    

    The time stamp indicating the earliest data to be returned.

    The value specified is inclusive; results include data points with the specified time stamp.

    CloudWatch rounds the specified time stamp as follows:

    • Start time less than 15 days ago - Round down to the nearest whole minute. For example, 12:32:34 is rounded down to 12:32:00.

    • Start time between 15 and 63 days ago - Round down to the nearest 5-minute clock interval. For example, 12:32:34 is rounded down to 12:30:00.

    • Start time greater than 63 days ago - Round down to the nearest 1-hour clock interval. For example, 12:32:34 is rounded down to 12:00:00.

    If you set Period to 5, 10, or 30, the start time of your request is rounded down to the nearest time that corresponds to even 5-, 10-, or 30-second divisions of a minute. For example, if you make a query at (HH:mm:ss) 01:05:23 for the previous 10-second period, the start time of your request is rounded down and you receive data from 01:05:10 to 01:05:20. If you make a query at 15:07:17 for the previous 5 minutes of data, using a period of 5 seconds, you receive data timestamped between 15:02:15 and 15:07:15.

    For better performance, specify StartTime and EndTime values that align with the value of the metric’s Period and sync up with the beginning and end of an hour. For example, if the Period of a metric is 5 minutes, specifying 12:05 or 12:30 as StartTime can get a faster response from CloudWatch than setting 12:07 or 12:29 as the StartTime.

    
    
  • end_time(DateTime) / set_end_time(Option<DateTime>):
    required: true
    

    The time stamp indicating the latest data to be returned.

    The value specified is exclusive; results include data points up to the specified time stamp.

    For better performance, specify StartTime and EndTime values that align with the value of the metric’s Period and sync up with the beginning and end of an hour. For example, if the Period of a metric is 5 minutes, specifying 12:05 or 12:30 as EndTime can get a faster response from CloudWatch than setting 12:07 or 12:29 as the EndTime.

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

    Include this value, if it was returned by the previous GetMetricData operation, to get the next set of data points.

    
    
  • scan_by(ScanBy) / set_scan_by(Option<ScanBy>):
    required: false
    

    The order in which data points should be returned. TimestampDescending returns the newest data first and paginates when the MaxDatapoints limit is reached. TimestampAscending returns the oldest data first and paginates when the MaxDatapoints limit is reached.

    If you omit this parameter, the default of TimestampDescending is used.

    
    
  • max_datapoints(i32) / set_max_datapoints(Option<i32>):
    required: false
    

    The maximum number of data points the request should return before paginating. If you omit this, the default of 100,800 is used.

    
    
  • label_options(LabelOptions) / set_label_options(Option<LabelOptions>):
    required: false
    

    This structure includes the Timezone parameter, which you can use to specify your time zone so that the labels of returned data display the correct time for your time zone.

    
    
• On success, responds with GetMetricDataOutput with field(s):
  • metric_data_results(Option<Vec::<MetricDataResult>>):

    The metrics that are returned, including the metric name, namespace, and dimensions.

  • next_token(Option<String>):

    A token that marks the next batch of returned results.

  • messages(Option<Vec::<MessageData>>):

    Contains a message about this GetMetricData operation, if the operation results in such a message. An example of a message that might be returned is Maximum number of allowed metrics exceeded. If there is a message, as much of the operation as possible is still executed.

    A message appears here only if it is related to the global GetMetricData operation. Any message about a specific metric returned by the operation appears in the MetricDataResult object returned for that metric.

• On failure, responds with SdkError<GetMetricDataError>

impl Client

pub fn get_metric_statistics(&self) -> GetMetricStatisticsFluentBuilder

Constructs a fluent builder for the GetMetricStatistics operation.

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

    The namespace of the metric, with or without spaces.

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

    The name of the metric, with or without spaces.

    
    
  • dimensions(Dimension) / set_dimensions(Option<Vec::<Dimension>>):
    required: false
    

    The dimensions. If the metric contains multiple dimensions, you must include a value for each dimension. CloudWatch treats each unique combination of dimensions as a separate metric. If a specific combination of dimensions was not published, you can’t retrieve statistics for it. You must specify the same dimensions that were used when the metrics were created. For an example, see Dimension Combinations in the Amazon CloudWatch User Guide. For more information about specifying dimensions, see Publishing Metrics in the Amazon CloudWatch User Guide.

    
    
  • start_time(DateTime) / set_start_time(Option<DateTime>):
    required: true
    

    The time stamp that determines the first data point to return. Start times are evaluated relative to the time that CloudWatch receives the request.

    The value specified is inclusive; results include data points with the specified time stamp. In a raw HTTP query, the time stamp must be in ISO 8601 UTC format (for example, 2016-10-03T23:00:00Z).

    CloudWatch rounds the specified time stamp as follows:

    • Start time less than 15 days ago - Round down to the nearest whole minute. For example, 12:32:34 is rounded down to 12:32:00.

    • Start time between 15 and 63 days ago - Round down to the nearest 5-minute clock interval. For example, 12:32:34 is rounded down to 12:30:00.

    • Start time greater than 63 days ago - Round down to the nearest 1-hour clock interval. For example, 12:32:34 is rounded down to 12:00:00.

    If you set Period to 5, 10, or 30, the start time of your request is rounded down to the nearest time that corresponds to even 5-, 10-, or 30-second divisions of a minute. For example, if you make a query at (HH:mm:ss) 01:05:23 for the previous 10-second period, the start time of your request is rounded down and you receive data from 01:05:10 to 01:05:20. If you make a query at 15:07:17 for the previous 5 minutes of data, using a period of 5 seconds, you receive data timestamped between 15:02:15 and 15:07:15.

    
    
  • end_time(DateTime) / set_end_time(Option<DateTime>):
    required: true
    

    The time stamp that determines the last data point to return.

    The value specified is exclusive; results include data points up to the specified time stamp. In a raw HTTP query, the time stamp must be in ISO 8601 UTC format (for example, 2016-10-10T23:00:00Z).

    
    
  • period(i32) / set_period(Option<i32>):
    required: true
    

    The granularity, in seconds, of the returned data points. For metrics with regular resolution, a period can be as short as one minute (60 seconds) and must be a multiple of 60. For high-resolution metrics that are collected at intervals of less than one minute, the period can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution metrics are those metrics stored by a PutMetricData call that includes a StorageResolution of 1 second.

    If the StartTime parameter specifies a time stamp that is greater than 3 hours ago, you must specify the period as follows or no data points in that time range is returned:

    • Start time between 3 hours and 15 days ago - Use a multiple of 60 seconds (1 minute).

    • Start time between 15 and 63 days ago - Use a multiple of 300 seconds (5 minutes).

    • Start time greater than 63 days ago - Use a multiple of 3600 seconds (1 hour).

    
    
  • statistics(Statistic) / set_statistics(Option<Vec::<Statistic>>):
    required: false
    

    The metric statistics, other than percentile. For percentile statistics, use ExtendedStatistics. When calling GetMetricStatistics, you must specify either Statistics or ExtendedStatistics, but not both.

    
    
  • extended_statistics(impl Into<String>) / set_extended_statistics(Option<Vec::<String>>):
    required: false
    

    The percentile statistics. Specify values between p0.0 and p100. When calling GetMetricStatistics, you must specify either Statistics or ExtendedStatistics, but not both. Percentile statistics are not available for metrics when any of the metric values are negative numbers.

    
    
  • unit(StandardUnit) / set_unit(Option<StandardUnit>):
    required: false
    

    The unit for a given metric. If you omit Unit, all data that was collected with any unit is returned, along with the corresponding units that were specified when the data was reported to CloudWatch. If you specify a unit, the operation returns only data that was collected with that unit specified. If you specify a unit that does not match the data collected, the results of the operation are null. CloudWatch does not perform unit conversions.

    
    
• On success, responds with GetMetricStatisticsOutput with field(s):
  • label(Option<String>):

    A label for the specified metric.

  • datapoints(Option<Vec::<Datapoint>>):

    The data points for the specified metric.

• On failure, responds with SdkError<GetMetricStatisticsError>

impl Client

pub fn get_metric_stream(&self) -> GetMetricStreamFluentBuilder

Constructs a fluent builder for the GetMetricStream operation.

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

    The name of the metric stream to retrieve information about.

    
    
• On success, responds with GetMetricStreamOutput with field(s):
  • arn(Option<String>):

    The ARN of the metric stream.

  • name(Option<String>):

    The name of the metric stream.

  • include_filters(Option<Vec::<MetricStreamFilter>>):

    If this array of metric namespaces is present, then these namespaces are the only metric namespaces that are streamed by this metric stream.

  • exclude_filters(Option<Vec::<MetricStreamFilter>>):

    If this array of metric namespaces is present, then these namespaces are the only metric namespaces that are not streamed by this metric stream. In this case, all other metric namespaces in the account are streamed by this metric stream.

  • firehose_arn(Option<String>):

    The ARN of the Amazon Kinesis Data Firehose delivery stream that is used by this metric stream.

  • role_arn(Option<String>):

    The ARN of the IAM role that is used by this metric stream.

  • state(Option<String>):

    The state of the metric stream. The possible values are running and stopped.

  • creation_date(Option<DateTime>):

    The date that the metric stream was created.

  • last_update_date(Option<DateTime>):

    The date of the most recent update to the metric stream’s configuration.

  • output_format(Option<MetricStreamOutputFormat>):

    The output format for the stream. Valid values are json, opentelemetry1.0, and opentelemetry0.7. For more information about metric stream output formats, see Metric streams output formats.

  • statistics_configurations(Option<Vec::<MetricStreamStatisticsConfiguration>>):

    Each entry in this array displays information about one or more metrics that include additional statistics in the metric stream. For more information about the additional statistics, see CloudWatch statistics definitions.

  • include_linked_accounts_metrics(Option<bool>):

    If this is true and this metric stream is in a monitoring account, then the stream includes metrics from source accounts that the monitoring account is linked to.

• On failure, responds with SdkError<GetMetricStreamError>

impl Client

pub fn get_metric_widget_image(&self) -> GetMetricWidgetImageFluentBuilder

Constructs a fluent builder for the GetMetricWidgetImage operation.

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

    A JSON string that defines the bitmap graph to be retrieved. The string includes the metrics to include in the graph, statistics, annotations, title, axis limits, and so on. You can include only one MetricWidget parameter in each GetMetricWidgetImage call.

    For more information about the syntax of MetricWidget see GetMetricWidgetImage: Metric Widget Structure and Syntax.

    If any metric on the graph could not load all the requested data points, an orange triangle with an exclamation point appears next to the graph legend.

    
    
  • output_format(impl Into<String>) / set_output_format(Option<String>):
    required: false
    

    The format of the resulting image. Only PNG images are supported.

    The default is png. If you specify png, the API returns an HTTP response with the content-type set to text/xml. The image data is in a MetricWidgetImage field. For example:

    >

    iVBORw0KGgoAAAANSUhEUgAAAlgAAAGQEAYAAAAip…

    6f0d4192-4d42-11e8-82c1-f539a07e0e3b

    The image/png setting is intended only for custom HTTP requests. For most use cases, and all actions using an Amazon Web Services SDK, you should use png. If you specify image/png, the HTTP response has a content-type set to image/png, and the body of the response is a PNG image.

    
    
• On success, responds with GetMetricWidgetImageOutput with field(s):
  • metric_widget_image(Option<Blob>):

    The image of the graph, in the output format specified. The output is base64-encoded.

• On failure, responds with SdkError<GetMetricWidgetImageError>

impl Client

pub fn list_dashboards(&self) -> ListDashboardsFluentBuilder

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

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

    If you specify this parameter, only the dashboards with names starting with the specified string are listed. The maximum length is 255, and valid characters are A-Z, a-z, 0-9, “.”, “-”, and “_”.

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

    The token returned by a previous call to indicate that there is more data available.

    
    
• On success, responds with ListDashboardsOutput with field(s):
  • dashboard_entries(Option<Vec::<DashboardEntry>>):

    The list of matching dashboards.

  • next_token(Option<String>):

    The token that marks the start of the next batch of returned results.

• On failure, responds with SdkError<ListDashboardsError>

impl Client

pub fn list_managed_insight_rules(&self) -> ListManagedInsightRulesFluentBuilder

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

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

    The ARN of an Amazon Web Services resource that has managed Contributor Insights rules.

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

    Include this value to get the next set of rules if the value was returned by the previous operation.

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

    The maximum number of results to return in one operation. If you omit this parameter, the default number is used. The default number is 100.

    
    
• On success, responds with ListManagedInsightRulesOutput with field(s):
  • managed_rules(Option<Vec::<ManagedRuleDescription>>):

    The managed rules that are available for the specified Amazon Web Services resource.

  • next_token(Option<String>):

    Include this value to get the next set of rules if the value was returned by the previous operation.

• On failure, responds with SdkError<ListManagedInsightRulesError>

impl Client

pub fn list_metric_streams(&self) -> ListMetricStreamsFluentBuilder

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

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

    Include this value, if it was returned by the previous call, to get the next set of metric streams.

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

    The maximum number of results to return in one operation.

    
    
• On success, responds with ListMetricStreamsOutput with field(s):
  • next_token(Option<String>):

    The token that marks the start of the next batch of returned results. You can use this token in a subsequent operation to get the next batch of results.

  • entries(Option<Vec::<MetricStreamEntry>>):

    The array of metric stream information.

• On failure, responds with SdkError<ListMetricStreamsError>

impl Client

pub fn list_metrics(&self) -> ListMetricsFluentBuilder

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

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

    The metric namespace to filter against. Only the namespace that matches exactly will be returned.

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

    The name of the metric to filter against. Only the metrics with names that match exactly will be returned.

    
    
  • dimensions(DimensionFilter) / set_dimensions(Option<Vec::<DimensionFilter>>):
    required: false
    

    The dimensions to filter against. Only the dimensions that match exactly will be returned.

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

    The token returned by a previous call to indicate that there is more data available.

    
    
  • recently_active(RecentlyActive) / set_recently_active(Option<RecentlyActive>):
    required: false
    

    To filter the results to show only metrics that have had data points published in the past three hours, specify this parameter with a value of PT3H. This is the only valid value for this parameter.

    The results that are returned are an approximation of the value you specify. There is a low probability that the returned results include metrics with last published data as much as 40 minutes more than the specified time interval.

    
    
  • include_linked_accounts(bool) / set_include_linked_accounts(Option<bool>):
    required: false
    

    If you are using this operation in a monitoring account, specify true to include metrics from source accounts in the returned data.

    The default is false.

    
    
  • owning_account(impl Into<String>) / set_owning_account(Option<String>):
    required: false
    

    When you use this operation in a monitoring account, use this field to return metrics only from one source account. To do so, specify that source account ID in this field, and also specify true for IncludeLinkedAccounts.

    
    
• On success, responds with ListMetricsOutput with field(s):
  • metrics(Option<Vec::<Metric>>):

    The metrics that match your request.

  • next_token(Option<String>):

    The token that marks the start of the next batch of returned results.

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

    If you are using this operation in a monitoring account, this array contains the account IDs of the source accounts where the metrics in the returned data are from.

    This field is a 1:1 mapping between each metric that is returned and the ID of the owning account.

• On failure, responds with SdkError<ListMetricsError>

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 ARN of the CloudWatch resource that you want to view tags for.

    The ARN format of an alarm is arn:aws:cloudwatch:Region:account-id:alarm:alarm-name

    The ARN format of a Contributor Insights rule is arn:aws:cloudwatch:Region:account-id:insight-rule/insight-rule-name

    For more information about ARN format, see Resource Types Defined by Amazon CloudWatch in the Amazon Web Services General Reference.

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

    The list of tag keys and values associated with the resource you specified.

• On failure, responds with SdkError<ListTagsForResourceError>

impl Client

pub fn put_anomaly_detector(&self) -> PutAnomalyDetectorFluentBuilder

Constructs a fluent builder for the PutAnomalyDetector operation.

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

    The namespace of the metric to create the anomaly detection model for.

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

    The name of the metric to create the anomaly detection model for.

    
    
  • dimensions(Dimension) / set_dimensions(Option<Vec::<Dimension>>):
    required: false
    

    The metric dimensions to create the anomaly detection model for.

    
    
  • stat(impl Into<String>) / set_stat(Option<String>):
    required: false
    

    The statistic to use for the metric and the anomaly detection model.

    
    
  • configuration(AnomalyDetectorConfiguration) / set_configuration(Option<AnomalyDetectorConfiguration>):
    required: false
    

    The configuration specifies details about how the anomaly detection model is to be trained, including time ranges to exclude when training and updating the model. You can specify as many as 10 time ranges.

    The configuration can also include the time zone to use for the metric.

    
    
  • metric_characteristics(MetricCharacteristics) / set_metric_characteristics(Option<MetricCharacteristics>):
    required: false
    

    Use this object to include parameters to provide information about your metric to CloudWatch to help it build more accurate anomaly detection models. Currently, it includes the PeriodicSpikes parameter.

    
    
  • single_metric_anomaly_detector(SingleMetricAnomalyDetector) / set_single_metric_anomaly_detector(Option<SingleMetricAnomalyDetector>):
    required: false
    

    A single metric anomaly detector to be created.

    When using SingleMetricAnomalyDetector, you cannot include the following parameters in the same operation:

    • Dimensions

    • MetricName

    • Namespace

    • Stat

    • the MetricMathAnomalyDetector parameters of PutAnomalyDetectorInput

    Instead, specify the single metric anomaly detector attributes as part of the property SingleMetricAnomalyDetector.

    
    
  • metric_math_anomaly_detector(MetricMathAnomalyDetector) / set_metric_math_anomaly_detector(Option<MetricMathAnomalyDetector>):
    required: false
    

    The metric math anomaly detector to be created.

    When using MetricMathAnomalyDetector, you cannot include the following parameters in the same operation:

    • Dimensions

    • MetricName

    • Namespace

    • Stat

    • the SingleMetricAnomalyDetector parameters of PutAnomalyDetectorInput

    Instead, specify the metric math anomaly detector attributes as part of the property MetricMathAnomalyDetector.

    
    
• On success, responds with PutAnomalyDetectorOutput
• On failure, responds with SdkError<PutAnomalyDetectorError>

impl Client

pub fn put_composite_alarm(&self) -> PutCompositeAlarmFluentBuilder

Constructs a fluent builder for the PutCompositeAlarm operation.

• The fluent builder is configurable:
  • actions_enabled(bool) / set_actions_enabled(Option<bool>):
    required: false
    

    Indicates whether actions should be executed during any changes to the alarm state of the composite alarm. The default is TRUE.

    
    
  • alarm_actions(impl Into<String>) / set_alarm_actions(Option<Vec::<String>>):
    required: false
    

    The actions to execute when this alarm transitions to the ALARM state from any other state. Each action is specified as an Amazon Resource Name (ARN).

    Valid Values: ]

    Amazon SNS actions:

    arn:aws:sns:region:account-id:sns-topic-name

    Lambda actions:

    • Invoke the latest version of a Lambda function: arn:aws:lambda:region:account-id:function:function-name

    • Invoke a specific version of a Lambda function: arn:aws:lambda:region:account-id:function:function-name:version-number

    • Invoke a function by using an alias Lambda function: arn:aws:lambda:region:account-id:function:function-name:alias-name

    Systems Manager actions:

    arn:aws:ssm:region:account-id:opsitem:severity

    
    
  • alarm_description(impl Into<String>) / set_alarm_description(Option<String>):
    required: false
    

    The description for the composite alarm.

    
    
  • alarm_name(impl Into<String>) / set_alarm_name(Option<String>):
    required: true
    

    The name for the composite alarm. This name must be unique within the Region.

    
    
  • alarm_rule(impl Into<String>) / set_alarm_rule(Option<String>):
    required: true
    

    An expression that specifies which other alarms are to be evaluated to determine this composite alarm’s state. For each alarm that you reference, you designate a function that specifies whether that alarm needs to be in ALARM state, OK state, or INSUFFICIENT_DATA state. You can use operators (AND, OR and NOT) to combine multiple functions in a single expression. You can use parenthesis to logically group the functions in your expression.

    You can use either alarm names or ARNs to reference the other alarms that are to be evaluated.

    Functions can include the following:

    • ALARM(“alarm-name or alarm-ARN”) is TRUE if the named alarm is in ALARM state.

    • OK(“alarm-name or alarm-ARN”) is TRUE if the named alarm is in OK state.

    • INSUFFICIENT_DATA(“alarm-name or alarm-ARN”) is TRUE if the named alarm is in INSUFFICIENT_DATA state.

    • TRUE always evaluates to TRUE.

    • FALSE always evaluates to FALSE.

    TRUE and FALSE are useful for testing a complex AlarmRule structure, and for testing your alarm actions.

    Alarm names specified in AlarmRule can be surrounded with double-quotes (“), but do not have to be.

    The following are some examples of AlarmRule:

    • ALARM(CPUUtilizationTooHigh) AND ALARM(DiskReadOpsTooHigh) specifies that the composite alarm goes into ALARM state only if both CPUUtilizationTooHigh and DiskReadOpsTooHigh alarms are in ALARM state.

    • ALARM(CPUUtilizationTooHigh) AND NOT ALARM(DeploymentInProgress) specifies that the alarm goes to ALARM state if CPUUtilizationTooHigh is in ALARM state and DeploymentInProgress is not in ALARM state. This example reduces alarm noise during a known deployment window.

    • (ALARM(CPUUtilizationTooHigh) OR ALARM(DiskReadOpsTooHigh)) AND OK(NetworkOutTooHigh) goes into ALARM state if CPUUtilizationTooHigh OR DiskReadOpsTooHigh is in ALARM state, and if NetworkOutTooHigh is in OK state. This provides another example of using a composite alarm to prevent noise. This rule ensures that you are not notified with an alarm action on high CPU or disk usage if a known network problem is also occurring.

    The AlarmRule can specify as many as 100 “children” alarms. The AlarmRule expression can have as many as 500 elements. Elements are child alarms, TRUE or FALSE statements, and parentheses.

    
    
  • insufficient_data_actions(impl Into<String>) / set_insufficient_data_actions(Option<Vec::<String>>):
    required: false
    

    The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state. Each action is specified as an Amazon Resource Name (ARN).

    Valid Values: ]

    Amazon SNS actions:

    arn:aws:sns:region:account-id:sns-topic-name

    Lambda actions:

    • Invoke the latest version of a Lambda function: arn:aws:lambda:region:account-id:function:function-name

    • Invoke a specific version of a Lambda function: arn:aws:lambda:region:account-id:function:function-name:version-number

    • Invoke a function by using an alias Lambda function: arn:aws:lambda:region:account-id:function:function-name:alias-name

    
    
  • ok_actions(impl Into<String>) / set_ok_actions(Option<Vec::<String>>):
    required: false
    

    The actions to execute when this alarm transitions to an OK state from any other state. Each action is specified as an Amazon Resource Name (ARN).

    Valid Values: ]

    Amazon SNS actions:

    arn:aws:sns:region:account-id:sns-topic-name

    Lambda actions:

    • Invoke the latest version of a Lambda function: arn:aws:lambda:region:account-id:function:function-name

    • Invoke a specific version of a Lambda function: arn:aws:lambda:region:account-id:function:function-name:version-number

    • Invoke a function by using an alias Lambda function: arn:aws:lambda:region:account-id:function:function-name:alias-name

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    A list of key-value pairs to associate with the alarm. You can associate as many as 50 tags with an alarm. To be able to associate tags with the alarm when you create the alarm, you must have the cloudwatch:TagResource permission.

    Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.

    If you are using this operation to update an existing alarm, any tags you specify in this parameter are ignored. To change the tags of an existing alarm, use TagResource or UntagResource.

    
    
  • actions_suppressor(impl Into<String>) / set_actions_suppressor(Option<String>):
    required: false
    

    Actions will be suppressed if the suppressor alarm is in the ALARM state. ActionsSuppressor can be an AlarmName or an Amazon Resource Name (ARN) from an existing alarm.

    
    
  • actions_suppressor_wait_period(i32) / set_actions_suppressor_wait_period(Option<i32>):
    required: false
    

    The maximum time in seconds that the composite alarm waits for the suppressor alarm to go into the ALARM state. After this time, the composite alarm performs its actions.

    WaitPeriod is required only when ActionsSuppressor is specified.

    
    
  • actions_suppressor_extension_period(i32) / set_actions_suppressor_extension_period(Option<i32>):
    required: false
    

    The maximum time in seconds that the composite alarm waits after suppressor alarm goes out of the ALARM state. After this time, the composite alarm performs its actions.

    ExtensionPeriod is required only when ActionsSuppressor is specified.

    
    
• On success, responds with PutCompositeAlarmOutput
• On failure, responds with SdkError<PutCompositeAlarmError>

impl Client

pub fn put_dashboard(&self) -> PutDashboardFluentBuilder

Constructs a fluent builder for the PutDashboard operation.

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

    The name of the dashboard. If a dashboard with this name already exists, this call modifies that dashboard, replacing its current contents. Otherwise, a new dashboard is created. The maximum length is 255, and valid characters are A-Z, a-z, 0-9, “-”, and “_”. This parameter is required.

    
    
  • dashboard_body(impl Into<String>) / set_dashboard_body(Option<String>):
    required: true
    

    The detailed information about the dashboard in JSON format, including the widgets to include and their location on the dashboard. This parameter is required.

    For more information about the syntax, see Dashboard Body Structure and Syntax.

    
    
• On success, responds with PutDashboardOutput with field(s):
  • dashboard_validation_messages(Option<Vec::<DashboardValidationMessage>>):

    If the input for PutDashboard was correct and the dashboard was successfully created or modified, this result is empty.

    If this result includes only warning messages, then the input was valid enough for the dashboard to be created or modified, but some elements of the dashboard might not render.

    If this result includes error messages, the input was not valid and the operation failed.

• On failure, responds with SdkError<PutDashboardError>

impl Client

pub fn put_insight_rule(&self) -> PutInsightRuleFluentBuilder

Constructs a fluent builder for the PutInsightRule operation.

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

    A unique name for the rule.

    
    
  • rule_state(impl Into<String>) / set_rule_state(Option<String>):
    required: false
    

    The state of the rule. Valid values are ENABLED and DISABLED.

    
    
  • rule_definition(impl Into<String>) / set_rule_definition(Option<String>):
    required: true
    

    The definition of the rule, as a JSON object. For details on the valid syntax, see Contributor Insights Rule Syntax.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    A list of key-value pairs to associate with the Contributor Insights rule. You can associate as many as 50 tags with a rule.

    Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only the resources that have certain tag values.

    To be able to associate tags with a rule, you must have the cloudwatch:TagResource permission in addition to the cloudwatch:PutInsightRule permission.

    If you are using this operation to update an existing Contributor Insights rule, any tags you specify in this parameter are ignored. To change the tags of an existing rule, use TagResource.

    
    
• On success, responds with PutInsightRuleOutput
• On failure, responds with SdkError<PutInsightRuleError>

impl Client

pub fn put_managed_insight_rules(&self) -> PutManagedInsightRulesFluentBuilder

Constructs a fluent builder for the PutManagedInsightRules operation.

• The fluent builder is configurable:
  • managed_rules(ManagedRule) / set_managed_rules(Option<Vec::<ManagedRule>>):
    required: true
    

    A list of ManagedRules to enable.

    
    
• On success, responds with PutManagedInsightRulesOutput with field(s):
  • failures(Option<Vec::<PartialFailure>>):

    An array that lists the rules that could not be enabled.

• On failure, responds with SdkError<PutManagedInsightRulesError>

impl Client

pub fn put_metric_alarm(&self) -> PutMetricAlarmFluentBuilder

Constructs a fluent builder for the PutMetricAlarm operation.

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

    The name for the alarm. This name must be unique within the Region.

    The name must contain only UTF-8 characters, and can’t contain ASCII control characters

    
    
  • alarm_description(impl Into<String>) / set_alarm_description(Option<String>):
    required: false
    

    The description for the alarm.

    
    
  • actions_enabled(bool) / set_actions_enabled(Option<bool>):
    required: false
    

    Indicates whether actions should be executed during any changes to the alarm state. The default is TRUE.

    
    
  • ok_actions(impl Into<String>) / set_ok_actions(Option<Vec::<String>>):
    required: false
    

    The actions to execute when this alarm transitions to an OK state from any other state. Each action is specified as an Amazon Resource Name (ARN). Valid values:

    EC2 actions:

    • arn:aws:automate:region:ec2:stop

    • arn:aws:automate:region:ec2:terminate

    • arn:aws:automate:region:ec2:reboot

    • arn:aws:automate:region:ec2:recover

    • arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Stop/1.0

    • arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Terminate/1.0

    • arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Reboot/1.0

    • arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Recover/1.0

    Autoscaling action:

    • arn:aws:autoscaling:region:account-id:scalingPolicy:policy-id:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name

    Lambda actions:

    • Invoke the latest version of a Lambda function: arn:aws:lambda:region:account-id:function:function-name

    • Invoke a specific version of a Lambda function: arn:aws:lambda:region:account-id:function:function-name:version-number

    • Invoke a function by using an alias Lambda function: arn:aws:lambda:region:account-id:function:function-name:alias-name

    SNS notification action:

    • arn:aws:sns:region:account-id:sns-topic-name

    SSM integration actions:

    • arn:aws:ssm:region:account-id:opsitem:severity#CATEGORY=category-name

    • arn:aws:ssm-incidents::account-id:responseplan/response-plan-name

    
    
  • alarm_actions(impl Into<String>) / set_alarm_actions(Option<Vec::<String>>):
    required: false
    

    The actions to execute when this alarm transitions to the ALARM state from any other state. Each action is specified as an Amazon Resource Name (ARN). Valid values:

    EC2 actions:

    • arn:aws:automate:region:ec2:stop

    • arn:aws:automate:region:ec2:terminate

    • arn:aws:automate:region:ec2:reboot

    • arn:aws:automate:region:ec2:recover

    • arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Stop/1.0

    • arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Terminate/1.0

    • arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Reboot/1.0

    • arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Recover/1.0

    Autoscaling action:

    • arn:aws:autoscaling:region:account-id:scalingPolicy:policy-id:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name

    Lambda actions:

    • Invoke the latest version of a Lambda function: arn:aws:lambda:region:account-id:function:function-name

    • Invoke a specific version of a Lambda function: arn:aws:lambda:region:account-id:function:function-name:version-number

    • Invoke a function by using an alias Lambda function: arn:aws:lambda:region:account-id:function:function-name:alias-name

    SNS notification action:

    • arn:aws:sns:region:account-id:sns-topic-name

    SSM integration actions:

    • arn:aws:ssm:region:account-id:opsitem:severity#CATEGORY=category-name

    • arn:aws:ssm-incidents::account-id:responseplan/response-plan-name

    
    
  • insufficient_data_actions(impl Into<String>) / set_insufficient_data_actions(Option<Vec::<String>>):
    required: false
    

    The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state. Each action is specified as an Amazon Resource Name (ARN). Valid values:

    EC2 actions:

    • arn:aws:automate:region:ec2:stop

    • arn:aws:automate:region:ec2:terminate

    • arn:aws:automate:region:ec2:reboot

    • arn:aws:automate:region:ec2:recover

    • arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Stop/1.0

    • arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Terminate/1.0

    • arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Reboot/1.0

    • arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Recover/1.0

    Autoscaling action:

    • arn:aws:autoscaling:region:account-id:scalingPolicy:policy-id:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name

    Lambda actions:

    • Invoke the latest version of a Lambda function: arn:aws:lambda:region:account-id:function:function-name

    • Invoke a specific version of a Lambda function: arn:aws:lambda:region:account-id:function:function-name:version-number

    • Invoke a function by using an alias Lambda function: arn:aws:lambda:region:account-id:function:function-name:alias-name

    SNS notification action:

    • arn:aws:sns:region:account-id:sns-topic-name

    SSM integration actions:

    • arn:aws:ssm:region:account-id:opsitem:severity#CATEGORY=category-name

    • arn:aws:ssm-incidents::account-id:responseplan/response-plan-name

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

    The name for the metric associated with the alarm. For each PutMetricAlarm operation, you must specify either MetricName or a Metrics array.

    If you are creating an alarm based on a math expression, you cannot specify this parameter, or any of the Namespace, Dimensions, Period, Unit, Statistic, or ExtendedStatistic parameters. Instead, you specify all this information in the Metrics array.

    
    
  • namespace(impl Into<String>) / set_namespace(Option<String>):
    required: false
    

    The namespace for the metric associated specified in MetricName.

    
    
  • statistic(Statistic) / set_statistic(Option<Statistic>):
    required: false
    

    The statistic for the metric specified in MetricName, other than percentile. For percentile statistics, use ExtendedStatistic. When you call PutMetricAlarm and specify a MetricName, you must specify either Statistic or ExtendedStatistic, but not both.

    
    
  • extended_statistic(impl Into<String>) / set_extended_statistic(Option<String>):
    required: false
    

    The extended statistic for the metric specified in MetricName. When you call PutMetricAlarm and specify a MetricName, you must specify either Statistic or ExtendedStatistic but not both.

    If you specify ExtendedStatistic, the following are valid values:

    • p90

    • tm90

    • tc90

    • ts90

    • wm90

    • IQM

    • PR(n:m) where n and m are values of the metric

    • TC(X%:X%) where X is between 10 and 90 inclusive.

    • TM(X%:X%) where X is between 10 and 90 inclusive.

    • TS(X%:X%) where X is between 10 and 90 inclusive.

    • WM(X%:X%) where X is between 10 and 90 inclusive.

    For more information about these extended statistics, see CloudWatch statistics definitions.

    
    
  • dimensions(Dimension) / set_dimensions(Option<Vec::<Dimension>>):
    required: false
    

    The dimensions for the metric specified in MetricName.

    
    
  • period(i32) / set_period(Option<i32>):
    required: false
    

    The length, in seconds, used each time the metric specified in MetricName is evaluated. Valid values are 10, 30, and any multiple of 60.

    Period is required for alarms based on static thresholds. If you are creating an alarm based on a metric math expression, you specify the period for each metric within the objects in the Metrics array.

    Be sure to specify 10 or 30 only for metrics that are stored by a PutMetricData call with a StorageResolution of 1. If you specify a period of 10 or 30 for a metric that does not have sub-minute resolution, the alarm still attempts to gather data at the period rate that you specify. In this case, it does not receive data for the attempts that do not correspond to a one-minute data resolution, and the alarm might often lapse into INSUFFICENT_DATA status. Specifying 10 or 30 also sets this alarm as a high-resolution alarm, which has a higher charge than other alarms. For more information about pricing, see Amazon CloudWatch Pricing.

    An alarm’s total current evaluation period can be no longer than one day, so Period multiplied by EvaluationPeriods cannot be more than 86,400 seconds.

    
    
  • unit(StandardUnit) / set_unit(Option<StandardUnit>):
    required: false
    

    The unit of measure for the statistic. For example, the units for the Amazon EC2 NetworkIn metric are Bytes because NetworkIn tracks the number of bytes that an instance receives on all network interfaces. You can also specify a unit when you create a custom metric. Units help provide conceptual meaning to your data. Metric data points that specify a unit of measure, such as Percent, are aggregated separately. If you are creating an alarm based on a metric math expression, you can specify the unit for each metric (if needed) within the objects in the Metrics array.

    If you don’t specify Unit, CloudWatch retrieves all unit types that have been published for the metric and attempts to evaluate the alarm. Usually, metrics are published with only one unit, so the alarm works as intended.

    However, if the metric is published with multiple types of units and you don’t specify a unit, the alarm’s behavior is not defined and it behaves unpredictably.

    We recommend omitting Unit so that you don’t inadvertently specify an incorrect unit that is not published for this metric. Doing so causes the alarm to be stuck in the INSUFFICIENT DATA state.

    
    
  • evaluation_periods(i32) / set_evaluation_periods(Option<i32>):
    required: true
    

    The number of periods over which data is compared to the specified threshold. If you are setting an alarm that requires that a number of consecutive data points be breaching to trigger the alarm, this value specifies that number. If you are setting an “M out of N” alarm, this value is the N.

    An alarm’s total current evaluation period can be no longer than one day, so this number multiplied by Period cannot be more than 86,400 seconds.

    
    
  • datapoints_to_alarm(i32) / set_datapoints_to_alarm(Option<i32>):
    required: false
    

    The number of data points that must be breaching to trigger the alarm. This is used only if you are setting an “M out of N” alarm. In that case, this value is the M. For more information, see Evaluating an Alarm in the Amazon CloudWatch User Guide.

    
    
  • threshold(f64) / set_threshold(Option<f64>):
    required: false
    

    The value against which the specified statistic is compared.

    This parameter is required for alarms based on static thresholds, but should not be used for alarms based on anomaly detection models.

    
    
  • comparison_operator(ComparisonOperator) / set_comparison_operator(Option<ComparisonOperator>):
    required: true
    

    The arithmetic operation to use when comparing the specified statistic and threshold. The specified statistic value is used as the first operand.

    The values LessThanLowerOrGreaterThanUpperThreshold, LessThanLowerThreshold, and GreaterThanUpperThreshold are used only for alarms based on anomaly detection models.

    
    
  • treat_missing_data(impl Into<String>) / set_treat_missing_data(Option<String>):
    required: false
    

    Sets how this alarm is to handle missing data points. If TreatMissingData is omitted, the default behavior of missing is used. For more information, see Configuring How CloudWatch Alarms Treats Missing Data.

    Valid Values: breaching | notBreaching | ignore | missing

    Alarms that evaluate metrics in the AWS/DynamoDB namespace always ignore missing data even if you choose a different option for TreatMissingData. When an AWS/DynamoDB metric has missing data, alarms that evaluate that metric remain in their current state.

    
    
  • evaluate_low_sample_count_percentile(impl Into<String>) / set_evaluate_low_sample_count_percentile(Option<String>):
    required: false
    

    Used only for alarms based on percentiles. If you specify ignore, the alarm state does not change during periods with too few data points to be statistically significant. If you specify evaluate or omit this parameter, the alarm is always evaluated and possibly changes state no matter how many data points are available. For more information, see Percentile-Based CloudWatch Alarms and Low Data Samples.

    Valid Values: evaluate | ignore

    
    
  • metrics(MetricDataQuery) / set_metrics(Option<Vec::<MetricDataQuery>>):
    required: false
    

    An array of MetricDataQuery structures that enable you to create an alarm based on the result of a metric math expression. For each PutMetricAlarm operation, you must specify either MetricName or a Metrics array.

    Each item in the Metrics array either retrieves a metric or performs a math expression.

    One item in the Metrics array is the expression that the alarm watches. You designate this expression by setting ReturnData to true for this object in the array. For more information, see MetricDataQuery.

    If you use the Metrics parameter, you cannot include the Namespace, MetricName, Dimensions, Period, Unit, Statistic, or ExtendedStatistic parameters of PutMetricAlarm in the same operation. Instead, you retrieve the metrics you are using in your math expression as part of the Metrics array.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    A list of key-value pairs to associate with the alarm. You can associate as many as 50 tags with an alarm. To be able to associate tags with the alarm when you create the alarm, you must have the cloudwatch:TagResource permission.

    Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.

    If you are using this operation to update an existing alarm, any tags you specify in this parameter are ignored. To change the tags of an existing alarm, use TagResource or UntagResource.

    
    
  • threshold_metric_id(impl Into<String>) / set_threshold_metric_id(Option<String>):
    required: false
    

    If this is an alarm based on an anomaly detection model, make this value match the ID of the ANOMALY_DETECTION_BAND function.

    For an example of how to use this parameter, see the Anomaly Detection Model Alarm example on this page.

    If your alarm uses this parameter, it cannot have Auto Scaling actions.

    
    
• On success, responds with PutMetricAlarmOutput
• On failure, responds with SdkError<PutMetricAlarmError>

impl Client

pub fn put_metric_data(&self) -> PutMetricDataFluentBuilder

Constructs a fluent builder for the PutMetricData operation.

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

    The namespace for the metric data. You can use ASCII characters for the namespace, except for control characters which are not supported.

    To avoid conflicts with Amazon Web Services service namespaces, you should not specify a namespace that begins with AWS/

    
    
  • metric_data(MetricDatum) / set_metric_data(Option<Vec::<MetricDatum>>):
    required: true
    

    The data for the metric. The array can include no more than 1000 metrics per call.

    
    
• On success, responds with PutMetricDataOutput
• On failure, responds with SdkError<PutMetricDataError>

impl Client

pub fn put_metric_stream(&self) -> PutMetricStreamFluentBuilder

Constructs a fluent builder for the PutMetricStream operation.

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

    If you are creating a new metric stream, this is the name for the new stream. The name must be different than the names of other metric streams in this account and Region.

    If you are updating a metric stream, specify the name of that stream here.

    Valid characters are A-Z, a-z, 0-9, “-” and “_”.

    
    
  • include_filters(MetricStreamFilter) / set_include_filters(Option<Vec::<MetricStreamFilter>>):
    required: false
    

    If you specify this parameter, the stream sends only the metrics from the metric namespaces that you specify here.

    You cannot include IncludeFilters and ExcludeFilters in the same operation.

    
    
  • exclude_filters(MetricStreamFilter) / set_exclude_filters(Option<Vec::<MetricStreamFilter>>):
    required: false
    

    If you specify this parameter, the stream sends metrics from all metric namespaces except for the namespaces that you specify here.

    You cannot include ExcludeFilters and IncludeFilters in the same operation.

    
    
  • firehose_arn(impl Into<String>) / set_firehose_arn(Option<String>):
    required: true
    

    The ARN of the Amazon Kinesis Data Firehose delivery stream to use for this metric stream. This Amazon Kinesis Data Firehose delivery stream must already exist and must be in the same account as the metric stream.

    
    
  • role_arn(impl Into<String>) / set_role_arn(Option<String>):
    required: true
    

    The ARN of an IAM role that this metric stream will use to access Amazon Kinesis Data Firehose resources. This IAM role must already exist and must be in the same account as the metric stream. This IAM role must include the following permissions:

    • firehose:PutRecord

    • firehose:PutRecordBatch

    
    
  • output_format(MetricStreamOutputFormat) / set_output_format(Option<MetricStreamOutputFormat>):
    required: true
    

    The output format for the stream. Valid values are json, opentelemetry1.0, and opentelemetry0.7. For more information about metric stream output formats, see Metric streams output formats.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    A list of key-value pairs to associate with the metric stream. You can associate as many as 50 tags with a metric stream.

    Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.

    You can use this parameter only when you are creating a new metric stream. If you are using this operation to update an existing metric stream, any tags you specify in this parameter are ignored. To change the tags of an existing metric stream, use TagResource or UntagResource.

    
    
  • statistics_configurations(MetricStreamStatisticsConfiguration) / set_statistics_configurations(Option<Vec::<MetricStreamStatisticsConfiguration>>):
    required: false
    

    By default, a metric stream always sends the MAX, MIN, SUM, and SAMPLECOUNT statistics for each metric that is streamed. You can use this parameter to have the metric stream also send additional statistics in the stream. This array can have up to 100 members.

    For each entry in this array, you specify one or more metrics and the list of additional statistics to stream for those metrics. The additional statistics that you can stream depend on the stream’s OutputFormat. If the OutputFormat is json, you can stream any additional statistic that is supported by CloudWatch, listed in CloudWatch statistics definitions. If the OutputFormat is opentelemetry1.0 or opentelemetry0.7, you can stream percentile statistics such as p95, p99.9, and so on.

    
    
  • include_linked_accounts_metrics(bool) / set_include_linked_accounts_metrics(Option<bool>):
    required: false
    

    If you are creating a metric stream in a monitoring account, specify true to include metrics from source accounts in the metric stream.

    
    
• On success, responds with PutMetricStreamOutput with field(s):
  • arn(Option<String>):

    The ARN of the metric stream.

• On failure, responds with SdkError<PutMetricStreamError>

impl Client

pub fn set_alarm_state(&self) -> SetAlarmStateFluentBuilder

Constructs a fluent builder for the SetAlarmState operation.

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

    The name of the alarm.

    
    
  • state_value(StateValue) / set_state_value(Option<StateValue>):
    required: true
    

    The value of the state.

    
    
  • state_reason(impl Into<String>) / set_state_reason(Option<String>):
    required: true
    

    The reason that this alarm is set to this specific state, in text format.

    
    
  • state_reason_data(impl Into<String>) / set_state_reason_data(Option<String>):
    required: false
    

    The reason that this alarm is set to this specific state, in JSON format.

    For SNS or EC2 alarm actions, this is just informational. But for EC2 Auto Scaling or application Auto Scaling alarm actions, the Auto Scaling policy uses the information in this field to take the correct action.

    
    
• On success, responds with SetAlarmStateOutput
• On failure, responds with SdkError<SetAlarmStateError>

impl Client

pub fn start_metric_streams(&self) -> StartMetricStreamsFluentBuilder

Constructs a fluent builder for the StartMetricStreams operation.

• The fluent builder is configurable:
  • names(impl Into<String>) / set_names(Option<Vec::<String>>):
    required: true
    

    The array of the names of metric streams to start streaming.

    This is an “all or nothing” operation. If you do not have permission to access all of the metric streams that you list here, then none of the streams that you list in the operation will start streaming.

    
    
• On success, responds with StartMetricStreamsOutput
• On failure, responds with SdkError<StartMetricStreamsError>

impl Client

pub fn stop_metric_streams(&self) -> StopMetricStreamsFluentBuilder

Constructs a fluent builder for the StopMetricStreams operation.

• The fluent builder is configurable:
  • names(impl Into<String>) / set_names(Option<Vec::<String>>):
    required: true
    

    The array of the names of metric streams to stop streaming.

    This is an “all or nothing” operation. If you do not have permission to access all of the metric streams that you list here, then none of the streams that you list in the operation will stop streaming.

    
    
• On success, responds with StopMetricStreamsOutput
• On failure, responds with SdkError<StopMetricStreamsError>

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 ARN of the CloudWatch resource that you’re adding tags to.

    The ARN format of an alarm is arn:aws:cloudwatch:Region:account-id:alarm:alarm-name

    The ARN format of a Contributor Insights rule is arn:aws:cloudwatch:Region:account-id:insight-rule/insight-rule-name

    For more information about ARN format, see Resource Types Defined by Amazon CloudWatch in the Amazon Web Services General Reference.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: true
    

    The list of key-value pairs to associate with the alarm.

    
    
• 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 ARN of the CloudWatch resource that you’re removing tags from.

    The ARN format of an alarm is arn:aws:cloudwatch:Region:account-id:alarm:alarm-name

    The ARN format of a Contributor Insights rule is arn:aws:cloudwatch:Region:account-id:insight-rule/insight-rule-name

    For more information about ARN format, see Resource Types Defined by Amazon CloudWatch in the Amazon Web Services General Reference.

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

    The list of tag keys to remove from the resource.

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

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