Class: Aws::Kendra::Types::DeletePrincipalMappingRequest

Inherits:

Struct

• Object
• Struct
• Aws::Kendra::Types::DeletePrincipalMappingRequest

Includes:

Structure

Defined in:

lib/aws-sdk-kendra/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #data_source_id ⇒ String

  The identifier of the data source you want to delete a group from.

• #group_id ⇒ String

  The identifier of the group you want to delete.

• #index_id ⇒ String

  The identifier of the index you want to delete a group from.

• #ordering_id ⇒ Integer

  The timestamp identifier you specify to ensure Amazon Kendra does not override the latest ‘DELETE` action with previous actions.

Instance Attribute Details

#data_source_id ⇒ String

The identifier of the data source you want to delete a group from.

A group can be tied to multiple data sources. You can delete a group from accessing documents in a certain data source. For example, the groups “Research”, “Engineering”, and “Sales and Marketing” are all tied to the company’s documents stored in the data sources Confluence and Salesforce. You want to delete “Research” and “Engineering” groups from Salesforce, so that these groups cannot access customer-related documents stored in Salesforce. Only “Sales and Marketing” should access documents in the Salesforce data source.

Returns:

• (String)

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

class DeletePrincipalMappingRequest < Struct.new(
  :index_id,
  :data_source_id,
  :group_id,
  :ordering_id)
  SENSITIVE = []
  include Aws::Structure
end

#group_id ⇒ String

The identifier of the group you want to delete.

Returns:

• (String)

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

class DeletePrincipalMappingRequest < Struct.new(
  :index_id,
  :data_source_id,
  :group_id,
  :ordering_id)
  SENSITIVE = []
  include Aws::Structure
end

#index_id ⇒ String

The identifier of the index you want to delete a group from.

Returns:

• (String)

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

class DeletePrincipalMappingRequest < Struct.new(
  :index_id,
  :data_source_id,
  :group_id,
  :ordering_id)
  SENSITIVE = []
  include Aws::Structure
end

#ordering_id ⇒ Integer

The timestamp identifier you specify to ensure Amazon Kendra does not override the latest ‘DELETE` action with previous actions. The highest number ID, which is the ordering ID, is the latest action you want to process and apply on top of other actions with lower number IDs. This prevents previous actions with lower number IDs from possibly overriding the latest action.

The ordering ID can be the Unix time of the last update you made to a group members list. You would then provide this list when calling ‘PutPrincipalMapping`. This ensures your `DELETE` action for that updated group with the latest members list doesn’t get overwritten by earlier ‘DELETE` actions for the same group which are yet to be processed.

The default ordering ID is the current Unix time in milliseconds that the action was received by Amazon Kendra.

Returns:

• (Integer)

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

class DeletePrincipalMappingRequest < Struct.new(
  :index_id,
  :data_source_id,
  :group_id,
  :ordering_id)
  SENSITIVE = []
  include Aws::Structure
end