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

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.

Instance Attribute Summary collapse

Instance Attribute Details

#principal_idString

The ID of the principal.

Returns:

  • (String)


2270
2271
2272
2273
2274
2275
2276
2277
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 2270

class ShareResult < Struct.new(
  :principal_id,
  :role,
  :status,
  :share_id,
  :status_message)
  include Aws::Structure
end

#roleString

The role.

Returns:

  • (String)


2270
2271
2272
2273
2274
2275
2276
2277
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 2270

class ShareResult < Struct.new(
  :principal_id,
  :role,
  :status,
  :share_id,
  :status_message)
  include Aws::Structure
end

#share_idString

The ID of the resource that was shared.

Returns:

  • (String)


2270
2271
2272
2273
2274
2275
2276
2277
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 2270

class ShareResult < Struct.new(
  :principal_id,
  :role,
  :status,
  :share_id,
  :status_message)
  include Aws::Structure
end

#statusString

The status.

Returns:

  • (String)


2270
2271
2272
2273
2274
2275
2276
2277
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 2270

class ShareResult < Struct.new(
  :principal_id,
  :role,
  :status,
  :share_id,
  :status_message)
  include Aws::Structure
end

#status_messageString

The status message.

Returns:

  • (String)


2270
2271
2272
2273
2274
2275
2276
2277
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 2270

class ShareResult < Struct.new(
  :principal_id,
  :role,
  :status,
  :share_id,
  :status_message)
  include Aws::Structure
end