aws_sdk_kendra/operation/delete_principal_mapping/builders.rs
1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::delete_principal_mapping::_delete_principal_mapping_output::DeletePrincipalMappingOutputBuilder;
3
4pub use crate::operation::delete_principal_mapping::_delete_principal_mapping_input::DeletePrincipalMappingInputBuilder;
5
6impl crate::operation::delete_principal_mapping::builders::DeletePrincipalMappingInputBuilder {
7 /// Sends a request with this input using the given client.
8 pub async fn send_with(
9 self,
10 client: &crate::Client,
11 ) -> ::std::result::Result<
12 crate::operation::delete_principal_mapping::DeletePrincipalMappingOutput,
13 ::aws_smithy_runtime_api::client::result::SdkError<
14 crate::operation::delete_principal_mapping::DeletePrincipalMappingError,
15 ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16 >,
17 > {
18 let mut fluent_builder = client.delete_principal_mapping();
19 fluent_builder.inner = self;
20 fluent_builder.send().await
21 }
22}
23/// Fluent builder constructing a request to `DeletePrincipalMapping`.
24///
25/// <p>Deletes a group so that all users that belong to the group can no longer access documents only available to that group.</p>
26/// <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>
27/// <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>
28/// <p><code>DeletePrincipalMapping</code> is currently not supported in the Amazon Web Services GovCloud (US-West) region.</p>
29#[derive(::std::clone::Clone, ::std::fmt::Debug)]
30pub struct DeletePrincipalMappingFluentBuilder {
31 handle: ::std::sync::Arc<crate::client::Handle>,
32 inner: crate::operation::delete_principal_mapping::builders::DeletePrincipalMappingInputBuilder,
33 config_override: ::std::option::Option<crate::config::Builder>,
34}
35impl
36 crate::client::customize::internal::CustomizableSend<
37 crate::operation::delete_principal_mapping::DeletePrincipalMappingOutput,
38 crate::operation::delete_principal_mapping::DeletePrincipalMappingError,
39 > for DeletePrincipalMappingFluentBuilder
40{
41 fn send(
42 self,
43 config_override: crate::config::Builder,
44 ) -> crate::client::customize::internal::BoxFuture<
45 crate::client::customize::internal::SendResult<
46 crate::operation::delete_principal_mapping::DeletePrincipalMappingOutput,
47 crate::operation::delete_principal_mapping::DeletePrincipalMappingError,
48 >,
49 > {
50 ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
51 }
52}
53impl DeletePrincipalMappingFluentBuilder {
54 /// Creates a new `DeletePrincipalMappingFluentBuilder`.
55 pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
56 Self {
57 handle,
58 inner: ::std::default::Default::default(),
59 config_override: ::std::option::Option::None,
60 }
61 }
62 /// Access the DeletePrincipalMapping as a reference.
63 pub fn as_input(&self) -> &crate::operation::delete_principal_mapping::builders::DeletePrincipalMappingInputBuilder {
64 &self.inner
65 }
66 /// Sends the request and returns the response.
67 ///
68 /// If an error occurs, an `SdkError` will be returned with additional details that
69 /// can be matched against.
70 ///
71 /// By default, any retryable failures will be retried twice. Retry behavior
72 /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
73 /// set when configuring the client.
74 pub async fn send(
75 self,
76 ) -> ::std::result::Result<
77 crate::operation::delete_principal_mapping::DeletePrincipalMappingOutput,
78 ::aws_smithy_runtime_api::client::result::SdkError<
79 crate::operation::delete_principal_mapping::DeletePrincipalMappingError,
80 ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
81 >,
82 > {
83 let input = self
84 .inner
85 .build()
86 .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
87 let runtime_plugins = crate::operation::delete_principal_mapping::DeletePrincipalMapping::operation_runtime_plugins(
88 self.handle.runtime_plugins.clone(),
89 &self.handle.conf,
90 self.config_override,
91 );
92 crate::operation::delete_principal_mapping::DeletePrincipalMapping::orchestrate(&runtime_plugins, input).await
93 }
94
95 /// Consumes this builder, creating a customizable operation that can be modified before being sent.
96 pub fn customize(
97 self,
98 ) -> crate::client::customize::CustomizableOperation<
99 crate::operation::delete_principal_mapping::DeletePrincipalMappingOutput,
100 crate::operation::delete_principal_mapping::DeletePrincipalMappingError,
101 Self,
102 > {
103 crate::client::customize::CustomizableOperation::new(self)
104 }
105 pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
106 self.set_config_override(::std::option::Option::Some(config_override.into()));
107 self
108 }
109
110 pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
111 self.config_override = config_override;
112 self
113 }
114 /// <p>The identifier of the index you want to delete a group from.</p>
115 pub fn index_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
116 self.inner = self.inner.index_id(input.into());
117 self
118 }
119 /// <p>The identifier of the index you want to delete a group from.</p>
120 pub fn set_index_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
121 self.inner = self.inner.set_index_id(input);
122 self
123 }
124 /// <p>The identifier of the index you want to delete a group from.</p>
125 pub fn get_index_id(&self) -> &::std::option::Option<::std::string::String> {
126 self.inner.get_index_id()
127 }
128 /// <p>The identifier of the data source you want to delete a group from.</p>
129 /// <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>
130 pub fn data_source_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
131 self.inner = self.inner.data_source_id(input.into());
132 self
133 }
134 /// <p>The identifier of the data source you want to delete a group from.</p>
135 /// <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>
136 pub fn set_data_source_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
137 self.inner = self.inner.set_data_source_id(input);
138 self
139 }
140 /// <p>The identifier of the data source you want to delete a group from.</p>
141 /// <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>
142 pub fn get_data_source_id(&self) -> &::std::option::Option<::std::string::String> {
143 self.inner.get_data_source_id()
144 }
145 /// <p>The identifier of the group you want to delete.</p>
146 pub fn group_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
147 self.inner = self.inner.group_id(input.into());
148 self
149 }
150 /// <p>The identifier of the group you want to delete.</p>
151 pub fn set_group_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
152 self.inner = self.inner.set_group_id(input);
153 self
154 }
155 /// <p>The identifier of the group you want to delete.</p>
156 pub fn get_group_id(&self) -> &::std::option::Option<::std::string::String> {
157 self.inner.get_group_id()
158 }
159 /// <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>
160 /// <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>
161 /// <p>The default ordering ID is the current Unix time in milliseconds that the action was received by Amazon Kendra.</p>
162 pub fn ordering_id(mut self, input: i64) -> Self {
163 self.inner = self.inner.ordering_id(input);
164 self
165 }
166 /// <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>
167 /// <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>
168 /// <p>The default ordering ID is the current Unix time in milliseconds that the action was received by Amazon Kendra.</p>
169 pub fn set_ordering_id(mut self, input: ::std::option::Option<i64>) -> Self {
170 self.inner = self.inner.set_ordering_id(input);
171 self
172 }
173 /// <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>
174 /// <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>
175 /// <p>The default ordering ID is the current Unix time in milliseconds that the action was received by Amazon Kendra.</p>
176 pub fn get_ordering_id(&self) -> &::std::option::Option<i64> {
177 self.inner.get_ordering_id()
178 }
179}