Principal - Amazon Kendra API Reference

Principal

Provides user and group information for user context filtering.

Contents

Access

Whether to allow or deny document access to the principal.

Type: String

Valid Values: ALLOW | DENY

Required: Yes

Name

The name of the user or group.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 200.

Pattern: ^\P{C}*$

Required: Yes

Type

The type of principal.

Type: String

Valid Values: USER | GROUP

Required: Yes

DataSourceId

The identifier of the data source the principal should access documents from.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: [a-zA-Z0-9][a-zA-Z0-9_-]*

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: