Skip to main content

aws_sdk_bedrockagentruntime/client/
check_ingested_document_acl.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 [`CheckIngestedDocumentAcl`](crate::operation::check_ingested_document_acl::builders::CheckIngestedDocumentAclFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`knowledge_base_id(impl Into<String>)`](crate::operation::check_ingested_document_acl::builders::CheckIngestedDocumentAclFluentBuilder::knowledge_base_id) / [`set_knowledge_base_id(Option<String>)`](crate::operation::check_ingested_document_acl::builders::CheckIngestedDocumentAclFluentBuilder::set_knowledge_base_id):<br>required: **true**<br><p>The unique identifier of the knowledge base that contains the document.</p><br>
7    ///   - [`data_source_id(impl Into<String>)`](crate::operation::check_ingested_document_acl::builders::CheckIngestedDocumentAclFluentBuilder::data_source_id) / [`set_data_source_id(Option<String>)`](crate::operation::check_ingested_document_acl::builders::CheckIngestedDocumentAclFluentBuilder::set_data_source_id):<br>required: **true**<br><p>The unique identifier of the data source that contains the document.</p><br>
8    ///   - [`document_id(impl Into<String>)`](crate::operation::check_ingested_document_acl::builders::CheckIngestedDocumentAclFluentBuilder::document_id) / [`set_document_id(Option<String>)`](crate::operation::check_ingested_document_acl::builders::CheckIngestedDocumentAclFluentBuilder::set_document_id):<br>required: **true**<br><p>The unique identifier of the document to check access for.</p><br>
9    ///   - [`user_context(UserContext)`](crate::operation::check_ingested_document_acl::builders::CheckIngestedDocumentAclFluentBuilder::user_context) / [`set_user_context(Option<UserContext>)`](crate::operation::check_ingested_document_acl::builders::CheckIngestedDocumentAclFluentBuilder::set_user_context):<br>required: **true**<br><p>The context object containing identity information for access control filtering, including user ID and optional group memberships used to evaluate the document access control list (ACL).</p><br>
10    /// - On success, responds with [`CheckIngestedDocumentAclOutput`](crate::operation::check_ingested_document_acl::CheckIngestedDocumentAclOutput) with field(s):
11    ///   - [`has_access(bool)`](crate::operation::check_ingested_document_acl::CheckIngestedDocumentAclOutput::has_access): <p>Specifies whether the user has access to the document based on the ingested access control list (ACL). Returns <code>true</code> if the user is allowed access, and <code>false</code> otherwise.</p>
12    /// - On failure, responds with [`SdkError<CheckIngestedDocumentAclError>`](crate::operation::check_ingested_document_acl::CheckIngestedDocumentAclError)
13    pub fn check_ingested_document_acl(&self) -> crate::operation::check_ingested_document_acl::builders::CheckIngestedDocumentAclFluentBuilder {
14        crate::operation::check_ingested_document_acl::builders::CheckIngestedDocumentAclFluentBuilder::new(self.handle.clone())
15    }
16}