aws_sdk_securityir/client/
get_membership.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 [`GetMembership`](crate::operation::get_membership::builders::GetMembershipFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`membership_id(impl Into<String>)`](crate::operation::get_membership::builders::GetMembershipFluentBuilder::membership_id) / [`set_membership_id(Option<String>)`](crate::operation::get_membership::builders::GetMembershipFluentBuilder::set_membership_id):<br>required: **true**<br><p>Required element for GetMembership to identify the membership ID to query.</p><br>
7    /// - On success, responds with [`GetMembershipOutput`](crate::operation::get_membership::GetMembershipOutput) with field(s):
8    ///   - [`membership_id(String)`](crate::operation::get_membership::GetMembershipOutput::membership_id): <p>Response element for GetMembership that provides the queried membership ID.</p>
9    ///   - [`account_id(Option<String>)`](crate::operation::get_membership::GetMembershipOutput::account_id): <p>Response element for GetMembership that provides the account configured to manage the membership.</p>
10    ///   - [`region(Option<AwsRegion>)`](crate::operation::get_membership::GetMembershipOutput::region): <p>Response element for GetMembership that provides the region configured to manage the membership.</p>
11    ///   - [`membership_name(Option<String>)`](crate::operation::get_membership::GetMembershipOutput::membership_name): <p>Response element for GetMembership that provides the configured membership name.</p>
12    ///   - [`membership_arn(Option<String>)`](crate::operation::get_membership::GetMembershipOutput::membership_arn): <p>Response element for GetMembership that provides the membership ARN.</p>
13    ///   - [`membership_status(Option<MembershipStatus>)`](crate::operation::get_membership::GetMembershipOutput::membership_status): <p>Response element for GetMembership that provides the current membership status.</p>
14    ///   - [`membership_activation_timestamp(Option<DateTime>)`](crate::operation::get_membership::GetMembershipOutput::membership_activation_timestamp): <p>Response element for GetMembership that provides the configured membership activation timestamp.</p>
15    ///   - [`membership_deactivation_timestamp(Option<DateTime>)`](crate::operation::get_membership::GetMembershipOutput::membership_deactivation_timestamp): <p>Response element for GetMembership that provides the configured membership name deactivation timestamp.</p>
16    ///   - [`customer_type(Option<CustomerType>)`](crate::operation::get_membership::GetMembershipOutput::customer_type): <p>Response element for GetMembership that provides the configured membership type. Options include <code> Standalone | Organizations</code>.</p>
17    ///   - [`number_of_accounts_covered(Option<i64>)`](crate::operation::get_membership::GetMembershipOutput::number_of_accounts_covered): <p>Response element for GetMembership that provides the number of accounts in the membership.</p>
18    ///   - [`incident_response_team(Option<Vec::<IncidentResponder>>)`](crate::operation::get_membership::GetMembershipOutput::incident_response_team): <p>Response element for GetMembership that provides the configured membership incident response team members.</p>
19    ///   - [`opt_in_features(Option<Vec::<OptInFeature>>)`](crate::operation::get_membership::GetMembershipOutput::opt_in_features): <p>Response element for GetMembership that provides the if opt-in features have been enabled.</p>
20    ///   - [`membership_accounts_configurations(Option<MembershipAccountsConfigurations>)`](crate::operation::get_membership::GetMembershipOutput::membership_accounts_configurations): <p>The <code>membershipAccountsConfigurations</code> field contains the configuration details for member accounts within the Amazon Web Services Organizations membership structure.</p> <p>This field returns a structure containing information about:</p> <ul>  <li>   <p>Account configurations for member accounts</p></li>  <li>   <p>Membership settings and preferences</p></li>  <li>   <p>Account-level permissions and roles</p></li> </ul>
21    /// - On failure, responds with [`SdkError<GetMembershipError>`](crate::operation::get_membership::GetMembershipError)
22    pub fn get_membership(&self) -> crate::operation::get_membership::builders::GetMembershipFluentBuilder {
23        crate::operation::get_membership::builders::GetMembershipFluentBuilder::new(self.handle.clone())
24    }
25}