aws_sdk_iam/client/

get_group.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`GetGroup`](crate::operation::get_group::builders::GetGroupFluentBuilder) operation.
    /// This operation supports pagination; See [`into_paginator()`](crate::operation::get_group::builders::GetGroupFluentBuilder::into_paginator).
    ///
    /// - The fluent builder is configurable:
    ///   - [`group_name(impl Into<String>)`](crate::operation::get_group::builders::GetGroupFluentBuilder::group_name) / [`set_group_name(Option<String>)`](crate::operation::get_group::builders::GetGroupFluentBuilder::set_group_name):<br>required: **true**<br><p>The name of the group.</p> <p>This parameter allows (through its <a href="http://wikipedia.org/wiki/regex">regex pattern</a>) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-</p><br>
    ///   - [`marker(impl Into<String>)`](crate::operation::get_group::builders::GetGroupFluentBuilder::marker) / [`set_marker(Option<String>)`](crate::operation::get_group::builders::GetGroupFluentBuilder::set_marker):<br>required: **false**<br><p>Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the <code>Marker</code> element in the response that you received to indicate where the next call should start.</p><br>
    ///   - [`max_items(i32)`](crate::operation::get_group::builders::GetGroupFluentBuilder::max_items) / [`set_max_items(Option<i32>)`](crate::operation::get_group::builders::GetGroupFluentBuilder::set_max_items):<br>required: **false**<br><p>Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the <code>IsTruncated</code> response element is <code>true</code>.</p> <p>If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the <code>IsTruncated</code> response element returns <code>true</code>, and <code>Marker</code> contains a value to include in the subsequent call that tells the service where to continue from.</p><br>
    /// - On success, responds with [`GetGroupOutput`](crate::operation::get_group::GetGroupOutput) with field(s):
    ///   - [`group(Option<Group>)`](crate::operation::get_group::GetGroupOutput::group): <p>A structure that contains details about the group.</p>
    ///   - [`users(Vec::<User>)`](crate::operation::get_group::GetGroupOutput::users): <p>A list of users in the group.</p>
    ///   - [`is_truncated(bool)`](crate::operation::get_group::GetGroupOutput::is_truncated): <p>A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the <code>Marker</code> request parameter to retrieve more items. Note that IAM might return fewer than the <code>MaxItems</code> number of results even when there are more results available. We recommend that you check <code>IsTruncated</code> after every call to ensure that you receive all your results.</p>
    ///   - [`marker(Option<String>)`](crate::operation::get_group::GetGroupOutput::marker): <p>When <code>IsTruncated</code> is <code>true</code>, this element is present and contains the value to use for the <code>Marker</code> parameter in a subsequent pagination request.</p>
    /// - On failure, responds with [`SdkError<GetGroupError>`](crate::operation::get_group::GetGroupError)
    pub fn get_group(&self) -> crate::operation::get_group::builders::GetGroupFluentBuilder {
        crate::operation::get_group::builders::GetGroupFluentBuilder::new(self.handle.clone())
    }
}