Class: Aws::Kendra::Types::DescribeAccessControlConfigurationResponse

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-kendra/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

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.

Returns:



3415
3416
3417
3418
3419
3420
3421
3422
3423
 
# File 'lib/aws-sdk-kendra/types.rb', line 3415

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.

Returns:

  • (String) 


3415
3416
3417
3418
3419
3420
3421
3422
3423
 
# File 'lib/aws-sdk-kendra/types.rb', line 3415

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.

Returns:

  • (String) 


3415
3416
3417
3418
3419
3420
3421
3422
3423
 
# File 'lib/aws-sdk-kendra/types.rb', line 3415

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.

[1]: docs.aws.amazon.com/kendra/latest/dg/API_Principal.html

Returns:



3415
3416
3417
3418
3419
3420
3421
3422
3423
 
# File 'lib/aws-sdk-kendra/types.rb', line 3415

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.

Returns:

  • (String) 


3415
3416
3417
3418
3419
3420
3421
3422
3423
 
# File 'lib/aws-sdk-kendra/types.rb', line 3415

class DescribeAccessControlConfigurationResponse < Struct.new(
  :name,
  :description,
  :error_message,
  :access_control_list,
  :hierarchical_access_control_list)
  SENSITIVE = []
  include Aws::Structure
end