Skip to content

Describes the permissions of a specified resource

Description

Describes the permissions of a specified resource.

Usage

workdocs_describe_resource_permissions(AuthenticationToken, ResourceId,
  PrincipalId, Limit, Marker)

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.

  • PrincipalId

    The ID of the principal to filter permissions by.

  • Limit

    The maximum number of items to return with this call.

  • Marker

    The marker for the next set of results. (You received this marker from a previous call)

Value

A list with the following syntax:

list(
  Principals = list(
    list(
      Id = "string",
      Type = "USER"|"GROUP"|"INVITE"|"ANONYMOUS"|"ORGANIZATION",
      Roles = list(
        list(
          Role = "VIEWER"|"CONTRIBUTOR"|"OWNER"|"COOWNER",
          Type = "DIRECT"|"INHERITED"
        )
      )
    )
  ),
  Marker = "string"
)

Request syntax

svc$describe_resource_permissions(
  AuthenticationToken = "string",
  ResourceId = "string",
  PrincipalId = "string",
  Limit = 123,
  Marker = "string"
)