Class: Aws::Kendra::Types::EntityPersonaConfiguration

Inherits:

Struct

Object
Struct
Aws::Kendra::Types::EntityPersonaConfiguration

show all

Defined in:: gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb

Overview

Note:

When making an API call, you may pass EntityPersonaConfiguration data as a hash:

{
  entity_id: "EntityId", # required
  persona: "OWNER", # required, accepts OWNER, VIEWER
}

Provides the configuration information for users or groups in your Amazon Web Services SSO identity source for access to your Amazon Kendra experience. Specific permissions are defined for each user or group once they are granted access to your Amazon Kendra experience.

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#entity_id ⇒ String
The identifier of a user or group in your Amazon Web Services SSO identity source.
#persona ⇒ String
The persona that defines the specific permissions of the user or group in your Amazon Web Services SSO identity source.

Instance Attribute Details

#entity_id ⇒ `String`

The identifier of a user or group in your Amazon Web Services SSO identity source. For example, a user ID could be an email.

Returns:

(String)

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

class EntityPersonaConfiguration < Struct.new(
  :entity_id,
  :persona)
  SENSITIVE = []
  include Aws::Structure
end

#persona ⇒ `String`

The persona that defines the specific permissions of the user or group in your Amazon Web Services SSO identity source. The available personas or access roles are Owner and Viewer. For more information on these personas, see Providing access to your search page.