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

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb

Overview

Note:

When making an API call, you may pass SharePrincipal data as a 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.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#id ⇒ String

The ID of the recipient.

Returns:

  • (String) 


2346
2347
2348
2349
2350
2351
 
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 2346

class SharePrincipal < Struct.new(
  :id,
  :type,
  :role)
  include Aws::Structure
end

#role ⇒ String

The role of the recipient.

Returns:

  • (String) 


2346
2347
2348
2349
2350
2351
 
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 2346

class SharePrincipal < Struct.new(
  :id,
  :type,
  :role)
  include Aws::Structure
end

#type ⇒ String

The type of the recipient.

Returns:

  • (String) 


2346
2347
2348
2349
2350
2351
 
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 2346

class SharePrincipal < Struct.new(
  :id,
  :type,
  :role)
  include Aws::Structure
end