aws_sdk_cloud9/client/
describe_environment_memberships.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`DescribeEnvironmentMemberships`](crate::operation::describe_environment_memberships::builders::DescribeEnvironmentMembershipsFluentBuilder) operation.
    /// This operation supports pagination; See [`into_paginator()`](crate::operation::describe_environment_memberships::builders::DescribeEnvironmentMembershipsFluentBuilder::into_paginator).
    ///
    /// - The fluent builder is configurable:
    ///   - [`user_arn(impl Into<String>)`](crate::operation::describe_environment_memberships::builders::DescribeEnvironmentMembershipsFluentBuilder::user_arn) / [`set_user_arn(Option<String>)`](crate::operation::describe_environment_memberships::builders::DescribeEnvironmentMembershipsFluentBuilder::set_user_arn):<br>required: **false**<br><p>The Amazon Resource Name (ARN) of an individual environment member to get information about. If no value is specified, information about all environment members are returned.</p><br>
    ///   - [`environment_id(impl Into<String>)`](crate::operation::describe_environment_memberships::builders::DescribeEnvironmentMembershipsFluentBuilder::environment_id) / [`set_environment_id(Option<String>)`](crate::operation::describe_environment_memberships::builders::DescribeEnvironmentMembershipsFluentBuilder::set_environment_id):<br>required: **false**<br><p>The ID of the environment to get environment member information about.</p><br>
    ///   - [`permissions(Permissions)`](crate::operation::describe_environment_memberships::builders::DescribeEnvironmentMembershipsFluentBuilder::permissions) / [`set_permissions(Option<Vec::<Permissions>>)`](crate::operation::describe_environment_memberships::builders::DescribeEnvironmentMembershipsFluentBuilder::set_permissions):<br>required: **false**<br><p>The type of environment member permissions to get information about. Available values include:</p> <ul>  <li>   <p><code>owner</code>: Owns the environment.</p></li>  <li>   <p><code>read-only</code>: Has read-only access to the environment.</p></li>  <li>   <p><code>read-write</code>: Has read-write access to the environment.</p></li> </ul> <p>If no value is specified, information about all environment members are returned.</p><br>
    ///   - [`next_token(impl Into<String>)`](crate::operation::describe_environment_memberships::builders::DescribeEnvironmentMembershipsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::describe_environment_memberships::builders::DescribeEnvironmentMembershipsFluentBuilder::set_next_token):<br>required: **false**<br><p>During a previous call, if there are more than 25 items in the list, only the first 25 items are returned, along with a unique string called a <i>next token</i>. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned.</p><br>
    ///   - [`max_results(i32)`](crate::operation::describe_environment_memberships::builders::DescribeEnvironmentMembershipsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::describe_environment_memberships::builders::DescribeEnvironmentMembershipsFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of environment members to get information about.</p><br>
    /// - On success, responds with [`DescribeEnvironmentMembershipsOutput`](crate::operation::describe_environment_memberships::DescribeEnvironmentMembershipsOutput) with field(s):
    ///   - [`memberships(Option<Vec::<EnvironmentMember>>)`](crate::operation::describe_environment_memberships::DescribeEnvironmentMembershipsOutput::memberships): <p>Information about the environment members for the environment.</p>
    ///   - [`next_token(Option<String>)`](crate::operation::describe_environment_memberships::DescribeEnvironmentMembershipsOutput::next_token): <p>If there are more than 25 items in the list, only the first 25 items are returned, along with a unique string called a <i>next token</i>. To get the next batch of items in the list, call this operation again, adding the next token to the call.</p>
    /// - On failure, responds with [`SdkError<DescribeEnvironmentMembershipsError>`](crate::operation::describe_environment_memberships::DescribeEnvironmentMembershipsError)
    pub fn describe_environment_memberships(
        &self,
    ) -> crate::operation::describe_environment_memberships::builders::DescribeEnvironmentMembershipsFluentBuilder {
        crate::operation::describe_environment_memberships::builders::DescribeEnvironmentMembershipsFluentBuilder::new(self.handle.clone())
    }
}