Class: Aws::Kendra::Types::DescribeAccessControlConfigurationResponse
- Inherits:
-
Struct
- Object
- Struct
- Aws::Kendra::Types::DescribeAccessControlConfigurationResponse
- Defined in:
- gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb
Overview
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#access_control_list ⇒ Array<Types::Principal>
Information on principals (users and/or groups) and which documents they should have access to.
-
#description ⇒ String
The description for the access control configuration.
-
#error_message ⇒ String
The error message containing details if there are issues processing the access control configuration.
-
#hierarchical_access_control_list ⇒ Array<Types::HierarchicalPrincipal>
The list of [principal][1] lists that define the hierarchy for which documents users should have access to.
-
#name ⇒ String
The name for the access control configuration.
Instance Attribute Details
#access_control_list ⇒ Array<Types::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.
3067 3068 3069 3070 3071 3072 3073 3074 3075 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 3067 class DescribeAccessControlConfigurationResponse < Struct.new( :name, :description, :error_message, :access_control_list, :hierarchical_access_control_list) SENSITIVE = [] include Aws::Structure end |
#description ⇒ String
The description for the access control configuration.
3067 3068 3069 3070 3071 3072 3073 3074 3075 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 3067 class DescribeAccessControlConfigurationResponse < Struct.new( :name, :description, :error_message, :access_control_list, :hierarchical_access_control_list) SENSITIVE = [] include Aws::Structure end |
#error_message ⇒ String
The error message containing details if there are issues processing the access control configuration.
3067 3068 3069 3070 3071 3072 3073 3074 3075 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 3067 class DescribeAccessControlConfigurationResponse < Struct.new( :name, :description, :error_message, :access_control_list, :hierarchical_access_control_list) SENSITIVE = [] include Aws::Structure end |
#hierarchical_access_control_list ⇒ Array<Types::HierarchicalPrincipal>
The list of principal lists that define the hierarchy for which documents users should have access to.
3067 3068 3069 3070 3071 3072 3073 3074 3075 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 3067 class DescribeAccessControlConfigurationResponse < Struct.new( :name, :description, :error_message, :access_control_list, :hierarchical_access_control_list) SENSITIVE = [] include Aws::Structure end |
#name ⇒ String
The name for the access control configuration.
3067 3068 3069 3070 3071 3072 3073 3074 3075 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 3067 class DescribeAccessControlConfigurationResponse < Struct.new( :name, :description, :error_message, :access_control_list, :hierarchical_access_control_list) SENSITIVE = [] include Aws::Structure end |