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

Class: Aws::WorkDocs::Types::AddResourcePermissionsRequest

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 AddResourcePermissionsRequest data as a hash:

{
  authentication_token: "AuthenticationHeaderType",
  resource_id: "ResourceIdType", # required
  principals: [ # required
    {
      id: "IdType", # required
      type: "USER", # required, accepts USER, GROUP, INVITE, ANONYMOUS, ORGANIZATION
      role: "VIEWER", # required, accepts VIEWER, CONTRIBUTOR, OWNER, COOWNER
    },
  ],
}

Instance Attribute Summary collapse

Instance Attribute Details

#authentication_tokenString

Amazon WorkDocs authentication token. This field should not be set when using administrative API actions, as in accessing the API using AWS credentials.

Returns:

  • (String)


164
165
166
167
168
169
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 164

class AddResourcePermissionsRequest < Struct.new(
  :authentication_token,
  :resource_id,
  :principals)
  include Aws::Structure
end

#principalsArray<Types::SharePrincipal>

The users, groups, or organization being granted permission.

Returns:



164
165
166
167
168
169
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 164

class AddResourcePermissionsRequest < Struct.new(
  :authentication_token,
  :resource_id,
  :principals)
  include Aws::Structure
end

#resource_idString

The ID of the resource.

Returns:

  • (String)


164
165
166
167
168
169
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 164

class AddResourcePermissionsRequest < Struct.new(
  :authentication_token,
  :resource_id,
  :principals)
  include Aws::Structure
end