SearchPrincipalType

Important

Notice: New customer sign-ups and account upgrades are no longer available for Amazon WorkDocs. Learn about migration steps here: How to migrate data from Amazon WorkDocs.

Filter based on UserIds or GroupIds.

Contents

Id

UserIds or GroupIds.

Type: String

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

Pattern: [&\w+-.@]+

Required: Yes

Roles

The Role of a User or Group.

Type: Array of strings

Array Members: Maximum number of 4 items.

Valid Values: VIEWER | CONTRIBUTOR | OWNER | COOWNER

Required: No

See Also

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

• AWS SDK for C++

• AWS SDK for Java V2

• AWS SDK for Ruby V3