aws_sdk_connect/client/
list_traffic_distribution_groups.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`ListTrafficDistributionGroups`](crate::operation::list_traffic_distribution_groups::builders::ListTrafficDistributionGroupsFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_traffic_distribution_groups::builders::ListTrafficDistributionGroupsFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`max_results(i32)`](crate::operation::list_traffic_distribution_groups::builders::ListTrafficDistributionGroupsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_traffic_distribution_groups::builders::ListTrafficDistributionGroupsFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of results to return per page.</p><br>
8    ///   - [`next_token(impl Into<String>)`](crate::operation::list_traffic_distribution_groups::builders::ListTrafficDistributionGroupsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_traffic_distribution_groups::builders::ListTrafficDistributionGroupsFluentBuilder::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>
9    ///   - [`instance_id(impl Into<String>)`](crate::operation::list_traffic_distribution_groups::builders::ListTrafficDistributionGroupsFluentBuilder::instance_id) / [`set_instance_id(Option<String>)`](crate::operation::list_traffic_distribution_groups::builders::ListTrafficDistributionGroupsFluentBuilder::set_instance_id):<br>required: **false**<br><p>The identifier of the Amazon Connect 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>
10    /// - On success, responds with [`ListTrafficDistributionGroupsOutput`](crate::operation::list_traffic_distribution_groups::ListTrafficDistributionGroupsOutput) with field(s):
11    ///   - [`next_token(Option<String>)`](crate::operation::list_traffic_distribution_groups::ListTrafficDistributionGroupsOutput::next_token): <p>If there are additional results, this is the token for the next set of results.</p>
12    ///   - [`traffic_distribution_group_summary_list(Option<Vec::<TrafficDistributionGroupSummary>>)`](crate::operation::list_traffic_distribution_groups::ListTrafficDistributionGroupsOutput::traffic_distribution_group_summary_list): <p>A list of traffic distribution groups.</p>
13    /// - On failure, responds with [`SdkError<ListTrafficDistributionGroupsError>`](crate::operation::list_traffic_distribution_groups::ListTrafficDistributionGroupsError)
14    pub fn list_traffic_distribution_groups(
15        &self,
16    ) -> crate::operation::list_traffic_distribution_groups::builders::ListTrafficDistributionGroupsFluentBuilder {
17        crate::operation::list_traffic_distribution_groups::builders::ListTrafficDistributionGroupsFluentBuilder::new(self.handle.clone())
18    }
19}