aws-sdk-connect 1.191.0

AWS SDK for Amazon Connect Service
Documentation
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`CreateMetric`](crate::operation::create_metric::builders::CreateMetricFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`instance_id(impl Into<String>)`](crate::operation::create_metric::builders::CreateMetricFluentBuilder::instance_id) / [`set_instance_id(Option<String>)`](crate::operation::create_metric::builders::CreateMetricFluentBuilder::set_instance_id):<br>required: **true**<br><p>The identifier of the Connect Customer instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p><br>
    ///   - [`name(impl Into<String>)`](crate::operation::create_metric::builders::CreateMetricFluentBuilder::name) / [`set_name(Option<String>)`](crate::operation::create_metric::builders::CreateMetricFluentBuilder::set_name):<br>required: **true**<br><p>The name of the metric.</p><br>
    ///   - [`metric_calculation(MetricCalculation)`](crate::operation::create_metric::builders::CreateMetricFluentBuilder::metric_calculation) / [`set_metric_calculation(Option<MetricCalculation>)`](crate::operation::create_metric::builders::CreateMetricFluentBuilder::set_metric_calculation):<br>required: **true**<br><p>The calculation definition for the metric, including the formula expression and the component metrics it references.</p><br>
    ///   - [`unit(MetricUnit)`](crate::operation::create_metric::builders::CreateMetricFluentBuilder::unit) / [`set_unit(Option<MetricUnit>)`](crate::operation::create_metric::builders::CreateMetricFluentBuilder::set_unit):<br>required: **true**<br><p>The display unit for the metric's data.</p><br>
    ///   - [`status(MetricStatus)`](crate::operation::create_metric::builders::CreateMetricFluentBuilder::status) / [`set_status(Option<MetricStatus>)`](crate::operation::create_metric::builders::CreateMetricFluentBuilder::set_status):<br>required: **false**<br><p>The publish status of the metric. Set to <code>PUBLISHED</code> to make the metric available for use in dashboards and reports, or <code>SAVED</code> to keep it in draft state.</p><br>
    ///   - [`client_token(impl Into<String>)`](crate::operation::create_metric::builders::CreateMetricFluentBuilder::client_token) / [`set_client_token(Option<String>)`](crate::operation::create_metric::builders::CreateMetricFluentBuilder::set_client_token):<br>required: **false**<br><p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p><br>
    ///   - [`description(impl Into<String>)`](crate::operation::create_metric::builders::CreateMetricFluentBuilder::description) / [`set_description(Option<String>)`](crate::operation::create_metric::builders::CreateMetricFluentBuilder::set_description):<br>required: **false**<br><p>The description of the metric.</p><br>
    ///   - [`positive_trend_indicator(TrendIndicator)`](crate::operation::create_metric::builders::CreateMetricFluentBuilder::positive_trend_indicator) / [`set_positive_trend_indicator(Option<TrendIndicator>)`](crate::operation::create_metric::builders::CreateMetricFluentBuilder::set_positive_trend_indicator):<br>required: **false**<br><p>How an increase in the metric value should be interpreted. Valid values: <code>POSITIVE</code>, <code>NEUTRAL</code>, <code>NEGATIVE</code>.</p><br>
    ///   - [`tags(impl Into<String>, impl Into<String>)`](crate::operation::create_metric::builders::CreateMetricFluentBuilder::tags) / [`set_tags(Option<HashMap::<String, String>>)`](crate::operation::create_metric::builders::CreateMetricFluentBuilder::set_tags):<br>required: **false**<br><p>The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.</p><br>
    /// - On success, responds with [`CreateMetricOutput`](crate::operation::create_metric::CreateMetricOutput) with field(s):
    ///   - [`metric_arn(String)`](crate::operation::create_metric::CreateMetricOutput::metric_arn): <p>The Amazon Resource Name (ARN) of the metric.</p>
    ///   - [`metric_id(String)`](crate::operation::create_metric::CreateMetricOutput::metric_id): <p>The identifier of the metric.</p>
    /// - On failure, responds with [`SdkError<CreateMetricError>`](crate::operation::create_metric::CreateMetricError)
    pub fn create_metric(&self) -> crate::operation::create_metric::builders::CreateMetricFluentBuilder {
        crate::operation::create_metric::builders::CreateMetricFluentBuilder::new(self.handle.clone())
    }
}