aws_sdk_wickr/client/
get_network.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 [`GetNetwork`](crate::operation::get_network::builders::GetNetworkFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`network_id(impl Into<String>)`](crate::operation::get_network::builders::GetNetworkFluentBuilder::network_id) / [`set_network_id(Option<String>)`](crate::operation::get_network::builders::GetNetworkFluentBuilder::set_network_id):<br>required: **true**<br><p>The ID of the Wickr network to retrieve.</p><br>
7    /// - On success, responds with [`GetNetworkOutput`](crate::operation::get_network::GetNetworkOutput) with field(s):
8    ///   - [`network_id(String)`](crate::operation::get_network::GetNetworkOutput::network_id): <p>The unique identifier of the network.</p>
9    ///   - [`network_name(String)`](crate::operation::get_network::GetNetworkOutput::network_name): <p>The name of the network.</p>
10    ///   - [`access_level(AccessLevel)`](crate::operation::get_network::GetNetworkOutput::access_level): <p>The access level of the network (STANDARD or PREMIUM), which determines available features and capabilities.</p>
11    ///   - [`aws_account_id(String)`](crate::operation::get_network::GetNetworkOutput::aws_account_id): <p>The Amazon Web Services account ID that owns the network.</p>
12    ///   - [`network_arn(String)`](crate::operation::get_network::GetNetworkOutput::network_arn): <p>The Amazon Resource Name (ARN) of the network.</p>
13    ///   - [`standing(Option<i32>)`](crate::operation::get_network::GetNetworkOutput::standing): <p>The current standing or status of the network.</p>
14    ///   - [`free_trial_expiration(Option<String>)`](crate::operation::get_network::GetNetworkOutput::free_trial_expiration): <p>The expiration date and time for the network's free trial period, if applicable.</p>
15    ///   - [`migration_state(Option<i32>)`](crate::operation::get_network::GetNetworkOutput::migration_state): <p>The SSO redirect URI migration state, managed by the SSO redirect migration wizard. Values: 0 (not started), 1 (in progress), or 2 (completed).</p>
16    ///   - [`encryption_key_arn(Option<String>)`](crate::operation::get_network::GetNetworkOutput::encryption_key_arn): <p>The ARN of the Amazon Web Services KMS customer managed key used for encrypting sensitive data in the network.</p>
17    /// - On failure, responds with [`SdkError<GetNetworkError>`](crate::operation::get_network::GetNetworkError)
18    pub fn get_network(&self) -> crate::operation::get_network::builders::GetNetworkFluentBuilder {
19        crate::operation::get_network::builders::GetNetworkFluentBuilder::new(self.handle.clone())
20    }
21}