Class: Aws::Kendra::Types::UpdateAccessControlConfigurationRequest

Inherits:

Struct

• Object
• Struct
• Aws::Kendra::Types::UpdateAccessControlConfigurationRequest

Includes:

Structure

Defined in:

lib/aws-sdk-kendra/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #access_control_list ⇒ Array<Types::Principal>

  Information you want to update on principals (users and/or groups) and which documents they should have access to.

• #description ⇒ String

  A new description for the access control configuration.

• #hierarchical_access_control_list ⇒ Array<Types::HierarchicalPrincipal>

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

• #id ⇒ String

  The identifier of the access control configuration you want to update.

• #index_id ⇒ String

  The identifier of the index for an access control configuration.

• #name ⇒ String

  A new name for the access control configuration.

Instance Attribute Details

#access_control_list ⇒ Array<Types::Principal>

Information you want to update 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:

• (Array<Types::Principal>)

# File 'lib/aws-sdk-kendra/types.rb', line 10470

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

#description ⇒ String

A new description for the access control configuration.

Returns:

• (String)

# File 'lib/aws-sdk-kendra/types.rb', line 10470

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

#hierarchical_access_control_list ⇒ Array<Types::HierarchicalPrincipal>

The updated 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:

• (Array<Types::HierarchicalPrincipal>)

# File 'lib/aws-sdk-kendra/types.rb', line 10470

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

#id ⇒ String

The identifier of the access control configuration you want to update.

Returns:

• (String)

# File 'lib/aws-sdk-kendra/types.rb', line 10470

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

#index_id ⇒ String

The identifier of the index for an access control configuration.

Returns:

• (String)

# File 'lib/aws-sdk-kendra/types.rb', line 10470

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

#name ⇒ String

A new name for the access control configuration.

Returns:

• (String)

# File 'lib/aws-sdk-kendra/types.rb', line 10470

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