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

ShareResult

Describes the share results of a resource.

Contents

PrincipalId

The ID of the principal.

Type: String

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

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

Required: No

Role

The role.

Type: String

Valid Values: VIEWER | CONTRIBUTOR | OWNER | COOWNER

Required: No

ShareId

The ID of the resource that was shared.

Type: String

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

Pattern: [\w+-.@]+

Required: No

Status

The status.

Type: String

Valid Values: SUCCESS | FAILURE

Required: No

StatusMessage

The status message.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 2048.

Required: No

See Also

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

On this page: