aws_sdk_synthetics/client/
list_associated_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 [`ListAssociatedGroups`](crate::operation::list_associated_groups::builders::ListAssociatedGroupsFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_associated_groups::builders::ListAssociatedGroupsFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`next_token(impl Into<String>)`](crate::operation::list_associated_groups::builders::ListAssociatedGroupsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_associated_groups::builders::ListAssociatedGroupsFluentBuilder::set_next_token):<br>required: **false**<br><p>A token that indicates that there is more data available. You can use this token in a subsequent operation to retrieve the next set of results.</p><br>
8    ///   - [`max_results(i32)`](crate::operation::list_associated_groups::builders::ListAssociatedGroupsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_associated_groups::builders::ListAssociatedGroupsFluentBuilder::set_max_results):<br>required: **false**<br><p>Specify this parameter to limit how many groups are returned each time you use the <code>ListAssociatedGroups</code> operation. If you omit this parameter, the default of 20 is used.</p><br>
9    ///   - [`resource_arn(impl Into<String>)`](crate::operation::list_associated_groups::builders::ListAssociatedGroupsFluentBuilder::resource_arn) / [`set_resource_arn(Option<String>)`](crate::operation::list_associated_groups::builders::ListAssociatedGroupsFluentBuilder::set_resource_arn):<br>required: **true**<br><p>The ARN of the canary that you want to view groups for.</p><br>
10    /// - On success, responds with [`ListAssociatedGroupsOutput`](crate::operation::list_associated_groups::ListAssociatedGroupsOutput) with field(s):
11    ///   - [`groups(Option<Vec::<GroupSummary>>)`](crate::operation::list_associated_groups::ListAssociatedGroupsOutput::groups): <p>An array of structures that contain information about the groups that this canary is associated with.</p>
12    ///   - [`next_token(Option<String>)`](crate::operation::list_associated_groups::ListAssociatedGroupsOutput::next_token): <p>A token that indicates that there is more data available. You can use this token in a subsequent <code>ListAssociatedGroups</code> operation to retrieve the next set of results.</p>
13    /// - On failure, responds with [`SdkError<ListAssociatedGroupsError>`](crate::operation::list_associated_groups::ListAssociatedGroupsError)
14    pub fn list_associated_groups(&self) -> crate::operation::list_associated_groups::builders::ListAssociatedGroupsFluentBuilder {
15        crate::operation::list_associated_groups::builders::ListAssociatedGroupsFluentBuilder::new(self.handle.clone())
16    }
17}
aws_sdk_synthetics/client/list_associated_groups.rs

aws_sdk_synthetics/client/
list_associated_groups.rs
