// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
pub use crate::operation::delete_principal_mapping::_delete_principal_mapping_input::DeletePrincipalMappingInputBuilder;
pub use crate::operation::delete_principal_mapping::_delete_principal_mapping_output::DeletePrincipalMappingOutputBuilder;
impl crate::operation::delete_principal_mapping::builders::DeletePrincipalMappingInputBuilder {
/// Sends a request with this input using the given client.
pub async fn send_with(
self,
client: &crate::Client,
) -> ::std::result::Result<
crate::operation::delete_principal_mapping::DeletePrincipalMappingOutput,
::aws_smithy_runtime_api::client::result::SdkError<
crate::operation::delete_principal_mapping::DeletePrincipalMappingError,
::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
>,
> {
let mut fluent_builder = client.delete_principal_mapping();
fluent_builder.inner = self;
fluent_builder.send().await
}
}
/// Fluent builder constructing a request to `DeletePrincipalMapping`.
///
/// <p>Deletes a group so that all users that belong to the group can no longer access documents only available to that group.</p>
/// <p>For example, after deleting the group "Summer Interns", all interns who belonged to that group no longer see intern-only documents in their search results.</p>
/// <p>If you want to delete or replace users or sub groups of a group, you need to use the <code>PutPrincipalMapping</code> operation. For example, if a user in the group "Engineering" leaves the engineering team and another user takes their place, you provide an updated list of users or sub groups that belong to the "Engineering" group when calling <code>PutPrincipalMapping</code>. You can update your internal list of users or sub groups and input this list when calling <code>PutPrincipalMapping</code>.</p>
/// <p><code>DeletePrincipalMapping</code> is currently not supported in the Amazon Web Services GovCloud (US-West) region.</p>
#[derive(::std::clone::Clone, ::std::fmt::Debug)]
pub struct DeletePrincipalMappingFluentBuilder {
handle: ::std::sync::Arc<crate::client::Handle>,
inner: crate::operation::delete_principal_mapping::builders::DeletePrincipalMappingInputBuilder,
config_override: ::std::option::Option<crate::config::Builder>,
}
impl
crate::client::customize::internal::CustomizableSend<
crate::operation::delete_principal_mapping::DeletePrincipalMappingOutput,
crate::operation::delete_principal_mapping::DeletePrincipalMappingError,
> for DeletePrincipalMappingFluentBuilder
{
fn send(
self,
config_override: crate::config::Builder,
) -> crate::client::customize::internal::BoxFuture<
crate::client::customize::internal::SendResult<
crate::operation::delete_principal_mapping::DeletePrincipalMappingOutput,
crate::operation::delete_principal_mapping::DeletePrincipalMappingError,
>,
> {
::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
}
}
impl DeletePrincipalMappingFluentBuilder {
/// Creates a new `DeletePrincipalMappingFluentBuilder`.
pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
Self {
handle,
inner: ::std::default::Default::default(),
config_override: ::std::option::Option::None,
}
}
/// Access the DeletePrincipalMapping as a reference.
pub fn as_input(&self) -> &crate::operation::delete_principal_mapping::builders::DeletePrincipalMappingInputBuilder {
&self.inner
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> ::std::result::Result<
crate::operation::delete_principal_mapping::DeletePrincipalMappingOutput,
::aws_smithy_runtime_api::client::result::SdkError<
crate::operation::delete_principal_mapping::DeletePrincipalMappingError,
::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
>,
> {
let input = self
.inner
.build()
.map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
let runtime_plugins = crate::operation::delete_principal_mapping::DeletePrincipalMapping::operation_runtime_plugins(
self.handle.runtime_plugins.clone(),
&self.handle.conf,
self.config_override,
);
crate::operation::delete_principal_mapping::DeletePrincipalMapping::orchestrate(&runtime_plugins, input).await
}
/// Consumes this builder, creating a customizable operation that can be modified before being sent.
pub fn customize(
self,
) -> crate::client::customize::CustomizableOperation<
crate::operation::delete_principal_mapping::DeletePrincipalMappingOutput,
crate::operation::delete_principal_mapping::DeletePrincipalMappingError,
Self,
> {
crate::client::customize::CustomizableOperation::new(self)
}
pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
self.set_config_override(::std::option::Option::Some(config_override.into()));
self
}
pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
self.config_override = config_override;
self
}
/// <p>The identifier of the index you want to delete a group from.</p>
pub fn index_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.inner = self.inner.index_id(input.into());
self
}
/// <p>The identifier of the index you want to delete a group from.</p>
pub fn set_index_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.inner = self.inner.set_index_id(input);
self
}
/// <p>The identifier of the index you want to delete a group from.</p>
pub fn get_index_id(&self) -> &::std::option::Option<::std::string::String> {
self.inner.get_index_id()
}
/// <p>The identifier of the data source you want to delete a group from.</p>
/// <p>A group can be tied to multiple data sources. You can delete a group from accessing documents in a certain data source. For example, the groups "Research", "Engineering", and "Sales and Marketing" are all tied to the company's documents stored in the data sources Confluence and Salesforce. You want to delete "Research" and "Engineering" groups from Salesforce, so that these groups cannot access customer-related documents stored in Salesforce. Only "Sales and Marketing" should access documents in the Salesforce data source.</p>
pub fn data_source_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.inner = self.inner.data_source_id(input.into());
self
}
/// <p>The identifier of the data source you want to delete a group from.</p>
/// <p>A group can be tied to multiple data sources. You can delete a group from accessing documents in a certain data source. For example, the groups "Research", "Engineering", and "Sales and Marketing" are all tied to the company's documents stored in the data sources Confluence and Salesforce. You want to delete "Research" and "Engineering" groups from Salesforce, so that these groups cannot access customer-related documents stored in Salesforce. Only "Sales and Marketing" should access documents in the Salesforce data source.</p>
pub fn set_data_source_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.inner = self.inner.set_data_source_id(input);
self
}
/// <p>The identifier of the data source you want to delete a group from.</p>
/// <p>A group can be tied to multiple data sources. You can delete a group from accessing documents in a certain data source. For example, the groups "Research", "Engineering", and "Sales and Marketing" are all tied to the company's documents stored in the data sources Confluence and Salesforce. You want to delete "Research" and "Engineering" groups from Salesforce, so that these groups cannot access customer-related documents stored in Salesforce. Only "Sales and Marketing" should access documents in the Salesforce data source.</p>
pub fn get_data_source_id(&self) -> &::std::option::Option<::std::string::String> {
self.inner.get_data_source_id()
}
/// <p>The identifier of the group you want to delete.</p>
pub fn group_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.inner = self.inner.group_id(input.into());
self
}
/// <p>The identifier of the group you want to delete.</p>
pub fn set_group_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.inner = self.inner.set_group_id(input);
self
}
/// <p>The identifier of the group you want to delete.</p>
pub fn get_group_id(&self) -> &::std::option::Option<::std::string::String> {
self.inner.get_group_id()
}
/// <p>The timestamp identifier you specify to ensure Amazon Kendra does not override the latest <code>DELETE</code> action with previous actions. The highest number ID, which is the ordering ID, is the latest action you want to process and apply on top of other actions with lower number IDs. This prevents previous actions with lower number IDs from possibly overriding the latest action.</p>
/// <p>The ordering ID can be the Unix time of the last update you made to a group members list. You would then provide this list when calling <code>PutPrincipalMapping</code>. This ensures your <code>DELETE</code> action for that updated group with the latest members list doesn't get overwritten by earlier <code>DELETE</code> actions for the same group which are yet to be processed.</p>
/// <p>The default ordering ID is the current Unix time in milliseconds that the action was received by Amazon Kendra.</p>
pub fn ordering_id(mut self, input: i64) -> Self {
self.inner = self.inner.ordering_id(input);
self
}
/// <p>The timestamp identifier you specify to ensure Amazon Kendra does not override the latest <code>DELETE</code> action with previous actions. The highest number ID, which is the ordering ID, is the latest action you want to process and apply on top of other actions with lower number IDs. This prevents previous actions with lower number IDs from possibly overriding the latest action.</p>
/// <p>The ordering ID can be the Unix time of the last update you made to a group members list. You would then provide this list when calling <code>PutPrincipalMapping</code>. This ensures your <code>DELETE</code> action for that updated group with the latest members list doesn't get overwritten by earlier <code>DELETE</code> actions for the same group which are yet to be processed.</p>
/// <p>The default ordering ID is the current Unix time in milliseconds that the action was received by Amazon Kendra.</p>
pub fn set_ordering_id(mut self, input: ::std::option::Option<i64>) -> Self {
self.inner = self.inner.set_ordering_id(input);
self
}
/// <p>The timestamp identifier you specify to ensure Amazon Kendra does not override the latest <code>DELETE</code> action with previous actions. The highest number ID, which is the ordering ID, is the latest action you want to process and apply on top of other actions with lower number IDs. This prevents previous actions with lower number IDs from possibly overriding the latest action.</p>
/// <p>The ordering ID can be the Unix time of the last update you made to a group members list. You would then provide this list when calling <code>PutPrincipalMapping</code>. This ensures your <code>DELETE</code> action for that updated group with the latest members list doesn't get overwritten by earlier <code>DELETE</code> actions for the same group which are yet to be processed.</p>
/// <p>The default ordering ID is the current Unix time in milliseconds that the action was received by Amazon Kendra.</p>
pub fn get_ordering_id(&self) -> &::std::option::Option<i64> {
self.inner.get_ordering_id()
}
}