Class: Aws::WorkDocs::Types::ShareResult

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

Overview

Describes the share results of a resource.

Constant Summary collapse

SENSITIVE =
[:status_message]

Instance Attribute Summary collapse

Instance Attribute Details

#invitee_principal_idString

The ID of the invited user.

Returns:

  • (String)


2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 2776

class ShareResult < Struct.new(
  :principal_id,
  :invitee_principal_id,
  :role,
  :status,
  :share_id,
  :status_message)
  SENSITIVE = [:status_message]
  include Aws::Structure
end

#principal_idString

The ID of the principal.

Returns:

  • (String)


2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 2776

class ShareResult < Struct.new(
  :principal_id,
  :invitee_principal_id,
  :role,
  :status,
  :share_id,
  :status_message)
  SENSITIVE = [:status_message]
  include Aws::Structure
end

#roleString

The role.

Returns:

  • (String)


2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 2776

class ShareResult < Struct.new(
  :principal_id,
  :invitee_principal_id,
  :role,
  :status,
  :share_id,
  :status_message)
  SENSITIVE = [:status_message]
  include Aws::Structure
end

#share_idString

The ID of the resource that was shared.

Returns:

  • (String)


2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 2776

class ShareResult < Struct.new(
  :principal_id,
  :invitee_principal_id,
  :role,
  :status,
  :share_id,
  :status_message)
  SENSITIVE = [:status_message]
  include Aws::Structure
end

#statusString

The status.

Returns:

  • (String)


2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 2776

class ShareResult < Struct.new(
  :principal_id,
  :invitee_principal_id,
  :role,
  :status,
  :share_id,
  :status_message)
  SENSITIVE = [:status_message]
  include Aws::Structure
end

#status_messageString

The status message.

Returns:

  • (String)


2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 2776

class ShareResult < Struct.new(
  :principal_id,
  :invitee_principal_id,
  :role,
  :status,
  :share_id,
  :status_message)
  SENSITIVE = [:status_message]
  include Aws::Structure
end