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

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

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#access_control_listArray<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:



5381
5382
5383
5384
5385
5386
5387
5388
5389
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 5381

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

#descriptionString

The description for the access control configuration.

Returns:

  • (String)


5381
5382
5383
5384
5385
5386
5387
5388
5389
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 5381

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

#error_messageString

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

Returns:

  • (String)


5381
5382
5383
5384
5385
5386
5387
5388
5389
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 5381

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

#hierarchical_access_control_listArray<Types::HierarchicalPrincipal>

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

Returns:



5381
5382
5383
5384
5385
5386
5387
5388
5389
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 5381

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

#nameString

The name for the access control configuration.

Returns:

  • (String)


5381
5382
5383
5384
5385
5386
5387
5388
5389
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 5381

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