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.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#idString

The ID of the recipient.

Returns:

  • (String)


2740
2741
2742
2743
2744
2745
2746
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 2740

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

#roleString

The role of the recipient.

Returns:

  • (String)


2740
2741
2742
2743
2744
2745
2746
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 2740

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

#typeString

The type of the recipient.

Returns:

  • (String)


2740
2741
2742
2743
2744
2745
2746
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 2740

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