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

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing AddResourcePermissionsRequest as input to an Aws::Client method, you can use a vanilla 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
    },
  ],
  notification_options: {
    send_email: false,
    email_message: "MessageType",
  },
}

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)

    Amazon WorkDocs authentication token.

#notification_optionsTypes::NotificationOptions

The notification options.

Returns:

#principalsArray<Types::SharePrincipal>

The users, groups, or organization being granted permission.

Returns:

#resource_idString

The ID of the resource.

Returns:

  • (String)

    The ID of the resource.