Struct aws_sdk_kendra::operation::describe_access_control_configuration::DescribeAccessControlConfigurationOutput

#[non_exhaustive]
pub struct DescribeAccessControlConfigurationOutput {
    pub name: String,
    pub description: Option<String>,
    pub error_message: Option<String>,
    pub access_control_list: Option<Vec<Principal>>,
    pub hierarchical_access_control_list: Option<Vec<HierarchicalPrincipal>>,
    /* private fields */
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

name: String

The name for the access control configuration.

description: Option<String>

The description for the access control configuration.

error_message: Option<String>

The error message containing details if there are issues processing the access control configuration.

access_control_list: Option<Vec<Principal>>

Information on principals (users and/or groups) and which documents they should have access to. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.

hierarchical_access_control_list: Option<Vec<HierarchicalPrincipal>>

The list of principal lists that define the hierarchy for which documents users should have access to.

Implementations

impl DescribeAccessControlConfigurationOutput

pub fn name(&self) -> &str

The name for the access control configuration.

pub fn description(&self) -> Option<&str>

The description for the access control configuration.

pub fn error_message(&self) -> Option<&str>

The error message containing details if there are issues processing the access control configuration.

pub fn access_control_list(&self) -> &[Principal]

Information on principals (users and/or groups) and which documents they should have access to. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .access_control_list.is_none().

pub fn hierarchical_access_control_list(&self) -> &[HierarchicalPrincipal]

The list of principal lists that define the hierarchy for which documents users should have access to.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .hierarchical_access_control_list.is_none().

impl DescribeAccessControlConfigurationOutput

pub fn builder() -> DescribeAccessControlConfigurationOutputBuilder

Creates a new builder-style object to manufacture DescribeAccessControlConfigurationOutput.

Trait Implementations

impl Clone for DescribeAccessControlConfigurationOutput

fn clone(&self) -> DescribeAccessControlConfigurationOutput

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DescribeAccessControlConfigurationOutput

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for DescribeAccessControlConfigurationOutput

fn eq(&self, other: &DescribeAccessControlConfigurationOutput) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl RequestId for DescribeAccessControlConfigurationOutput

fn request_id(&self) -> Option<&str>

Returns the request ID, or None if the service could not be reached.

impl StructuralPartialEq for DescribeAccessControlConfigurationOutput