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

Class: Aws::WorkDocs::Types::RemoveResourcePermissionRequest

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

{
  authentication_token: "AuthenticationHeaderType",
  resource_id: "ResourceIdType", # required
  principal_id: "IdType", # required
  principal_type: "USER", # accepts USER, GROUP, INVITE, ANONYMOUS, ORGANIZATION
}

Instance Attribute Summary collapse

Instance Attribute Details

#authentication_tokenString

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

Returns:

  • (String)


2238
2239
2240
2241
2242
2243
2244
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 2238

class RemoveResourcePermissionRequest < Struct.new(
  :authentication_token,
  :resource_id,
  :principal_id,
  :principal_type)
  include Aws::Structure
end

#principal_idString

The principal ID of the resource.

Returns:

  • (String)


2238
2239
2240
2241
2242
2243
2244
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 2238

class RemoveResourcePermissionRequest < Struct.new(
  :authentication_token,
  :resource_id,
  :principal_id,
  :principal_type)
  include Aws::Structure
end

#principal_typeString

The principal type of the resource.

Returns:

  • (String)


2238
2239
2240
2241
2242
2243
2244
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 2238

class RemoveResourcePermissionRequest < Struct.new(
  :authentication_token,
  :resource_id,
  :principal_id,
  :principal_type)
  include Aws::Structure
end

#resource_idString

The ID of the resource.

Returns:

  • (String)


2238
2239
2240
2241
2242
2243
2244
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 2238

class RemoveResourcePermissionRequest < Struct.new(
  :authentication_token,
  :resource_id,
  :principal_id,
  :principal_type)
  include Aws::Structure
end