Amazon WorkDocs
API Reference (API Version 2016-05-01)

The AWS Documentation website is getting a new look!
Try it now and let us know what you think. Switch to the new look >>

You can return to the original look by selecting English in the language selector above.

SharePrincipal

Describes the recipient type and ID, if available.

Contents

Id

The ID of the recipient.

Type: String

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

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

Required: Yes

Role

The role of the recipient.

Type: String

Valid Values: VIEWER | CONTRIBUTOR | OWNER | COOWNER

Required: Yes

Type

The type of the recipient.

Type: String

Valid Values: USER | GROUP | INVITE | ANONYMOUS | ORGANIZATION

Required: Yes

See Also

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

On this page: