AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::WorkDocs::Types::SharePrincipal

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing SharePrincipal as input to an Aws::Client method, you can use a vanilla Hash:

{
  id: "IdType", # required
  type: "USER", # required, accepts USER, GROUP, INVITE, ANONYMOUS, ORGANIZATION
  role: "VIEWER", # required, accepts VIEWER, CONTRIBUTOR, OWNER, COOWNER
}

Describes the recipient type and ID, if available.

Instance Attribute Summary collapse

Instance Attribute Details

#idString

The ID of the recipient.

Returns:

  • (String)

    The ID of the recipient.

#roleString

The role of the recipient.

Possible values:

  • VIEWER
  • CONTRIBUTOR
  • OWNER
  • COOWNER

Returns:

  • (String)

    The role of the recipient.

#typeString

The type of the recipient.

Possible values:

  • USER
  • GROUP
  • INVITE
  • ANONYMOUS
  • ORGANIZATION

Returns:

  • (String)

    The type of the recipient.