aws-sdk-connect 1.195.0

AWS SDK for Amazon Connect Service
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`ListMetrics`](crate::operation::list_metrics::builders::ListMetricsFluentBuilder) operation.
    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_metrics::builders::ListMetricsFluentBuilder::into_paginator).
    ///
    /// - The fluent builder is configurable:
    ///   - [`instance_id(impl Into<String>)`](crate::operation::list_metrics::builders::ListMetricsFluentBuilder::instance_id) / [`set_instance_id(Option<String>)`](crate::operation::list_metrics::builders::ListMetricsFluentBuilder::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>
    ///   - [`r#type(MetricType)`](crate::operation::list_metrics::builders::ListMetricsFluentBuilder::type) / [`set_type(Option<MetricType>)`](crate::operation::list_metrics::builders::ListMetricsFluentBuilder::set_type):<br>required: **false**<br><p>The type of metrics to list. Valid values: <code>AWS_MANAGED</code> | <code>CUSTOMER_MANAGED</code>.</p><br>
    ///   - [`max_results(i32)`](crate::operation::list_metrics::builders::ListMetricsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_metrics::builders::ListMetricsFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of results to return per page.</p><br>
    ///   - [`next_token(impl Into<String>)`](crate::operation::list_metrics::builders::ListMetricsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_metrics::builders::ListMetricsFluentBuilder::set_next_token):<br>required: **false**<br><p>The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.</p><br>
    /// - On success, responds with [`ListMetricsOutput`](crate::operation::list_metrics::ListMetricsOutput) with field(s):
    ///   - [`metric_summary_list(Vec::<MetricSummary>)`](crate::operation::list_metrics::ListMetricsOutput::metric_summary_list): <p>The list of metric summaries.</p>
    ///   - [`next_token(Option<String>)`](crate::operation::list_metrics::ListMetricsOutput::next_token): <p>If there are additional results, this is the token for the next set of results.</p>
    /// - On failure, responds with [`SdkError<ListMetricsError>`](crate::operation::list_metrics::ListMetricsError)
    pub fn list_metrics(&self) -> crate::operation::list_metrics::builders::ListMetricsFluentBuilder {
        crate::operation::list_metrics::builders::ListMetricsFluentBuilder::new(self.handle.clone())
    }
}