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

Inherits:

Struct

• Object
• Struct
• Aws::WorkDocs::Types::ShareResult

Includes:

Structure

Defined in:

lib/aws-sdk-workdocs/types.rb

Overview

Describes the share results of a resource.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:status_message]

Instance Attribute Summary

• #invitee_principal_id ⇒ String

  The ID of the invited user.

• #principal_id ⇒ String

  The ID of the principal.

• #role ⇒ String

  The role.

• #share_id ⇒ String

  The ID of the resource that was shared.

• #status ⇒ String

  The status.

• #status_message ⇒ String

  The status message.

Instance Attribute Details

#invitee_principal_id ⇒ String

The ID of the invited user.

Returns:

• (String)

# File 'lib/aws-sdk-workdocs/types.rb', line 2688

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

#principal_id ⇒ String

The ID of the principal.

Returns:

• (String)

# File 'lib/aws-sdk-workdocs/types.rb', line 2688

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

#role ⇒ String

The role.

Returns:

• (String)

# File 'lib/aws-sdk-workdocs/types.rb', line 2688

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

#share_id ⇒ String

The ID of the resource that was shared.

Returns:

• (String)

# File 'lib/aws-sdk-workdocs/types.rb', line 2688

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

#status ⇒ String

The status.

Returns:

• (String)

# File 'lib/aws-sdk-workdocs/types.rb', line 2688

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

#status_message ⇒ String

The status message.

Returns:

• (String)

# File 'lib/aws-sdk-workdocs/types.rb', line 2688

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