1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`DescribePrincipalMapping`](crate::operation::describe_principal_mapping::builders::DescribePrincipalMappingFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`index_id(impl Into<String>)`](crate::operation::describe_principal_mapping::builders::DescribePrincipalMappingFluentBuilder::index_id) / [`set_index_id(Option<String>)`](crate::operation::describe_principal_mapping::builders::DescribePrincipalMappingFluentBuilder::set_index_id):<br>required: **true**<br><p>The identifier of the index required to check the processing of <code>PUT</code> and <code>DELETE</code> actions for mapping users to their groups.</p><br>
    ///   - [`data_source_id(impl Into<String>)`](crate::operation::describe_principal_mapping::builders::DescribePrincipalMappingFluentBuilder::data_source_id) / [`set_data_source_id(Option<String>)`](crate::operation::describe_principal_mapping::builders::DescribePrincipalMappingFluentBuilder::set_data_source_id):<br>required: **false**<br><p>The identifier of the data source to check the processing of <code>PUT</code> and <code>DELETE</code> actions for mapping users to their groups.</p><br>
    ///   - [`group_id(impl Into<String>)`](crate::operation::describe_principal_mapping::builders::DescribePrincipalMappingFluentBuilder::group_id) / [`set_group_id(Option<String>)`](crate::operation::describe_principal_mapping::builders::DescribePrincipalMappingFluentBuilder::set_group_id):<br>required: **true**<br><p>The identifier of the group required to check the processing of <code>PUT</code> and <code>DELETE</code> actions for mapping users to their groups.</p><br>
    /// - On success, responds with [`DescribePrincipalMappingOutput`](crate::operation::describe_principal_mapping::DescribePrincipalMappingOutput) with field(s):
    ///   - [`index_id(Option<String>)`](crate::operation::describe_principal_mapping::DescribePrincipalMappingOutput::index_id): <p>Shows the identifier of the index to see information on the processing of <code>PUT</code> and <code>DELETE</code> actions for mapping users to their groups.</p>
    ///   - [`data_source_id(Option<String>)`](crate::operation::describe_principal_mapping::DescribePrincipalMappingOutput::data_source_id): <p>Shows the identifier of the data source to see information on the processing of <code>PUT</code> and <code>DELETE</code> actions for mapping users to their groups.</p>
    ///   - [`group_id(Option<String>)`](crate::operation::describe_principal_mapping::DescribePrincipalMappingOutput::group_id): <p>Shows the identifier of the group to see information on the processing of <code>PUT</code> and <code>DELETE</code> actions for mapping users to their groups.</p>
    ///   - [`group_ordering_id_summaries(Option<Vec::<GroupOrderingIdSummary>>)`](crate::operation::describe_principal_mapping::DescribePrincipalMappingOutput::group_ordering_id_summaries): <p>Shows the following information on the processing of <code>PUT</code> and <code>DELETE</code> actions for mapping users to their groups:</p> <ul>  <li>   <p>Status—the status can be either <code>PROCESSING</code>, <code>SUCCEEDED</code>, <code>DELETING</code>, <code>DELETED</code>, or <code>FAILED</code>.</p></li>  <li>   <p>Last updated—the last date-time an action was updated.</p></li>  <li>   <p>Received—the last date-time an action was received or submitted.</p></li>  <li>   <p>Ordering ID—the latest action that should process and apply after other actions.</p></li>  <li>   <p>Failure reason—the reason an action could not be processed.</p></li> </ul>
    /// - On failure, responds with [`SdkError<DescribePrincipalMappingError>`](crate::operation::describe_principal_mapping::DescribePrincipalMappingError)
    pub fn describe_principal_mapping(&self) -> crate::operation::describe_principal_mapping::builders::DescribePrincipalMappingFluentBuilder {
        crate::operation::describe_principal_mapping::builders::DescribePrincipalMappingFluentBuilder::new(self.handle.clone())
    }
}