Add Resource Permissions

workdocs_add_resource_permissions

R Documentation

Creates a set of permissions for the specified folder or document¶

Description¶

Creates a set of permissions for the specified folder or document. The resource permissions are overwritten if the principals already have different permissions.

Usage¶

workdocs_add_resource_permissions(AuthenticationToken, ResourceId,
  Principals, NotificationOptions)

Arguments¶

AuthenticationToken: Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.
ResourceId: [required] The ID of the resource.
Principals: [required] The users, groups, or organization being granted permission.
NotificationOptions: The notification options.

Value¶

A list with the following syntax:

list(
  ShareResults = list(
    list(
      PrincipalId = "string",
      InviteePrincipalId = "string",
      Role = "VIEWER"|"CONTRIBUTOR"|"OWNER"|"COOWNER",
      Status = "SUCCESS"|"FAILURE",
      ShareId = "string",
      StatusMessage = "string"
    )
  )
)

Request syntax¶

svc$add_resource_permissions(
  AuthenticationToken = "string",
  ResourceId = "string",
  Principals = list(
    list(
      Id = "string",
      Type = "USER"|"GROUP"|"INVITE"|"ANONYMOUS"|"ORGANIZATION",
      Role = "VIEWER"|"CONTRIBUTOR"|"OWNER"|"COOWNER"
    )
  ),
  NotificationOptions = list(
    SendEmail = TRUE|FALSE,
    EmailMessage = "string"
  )
)