WorkDocs / Client / describe_resource_permissions

describe_resource_permissions#

WorkDocs.Client.describe_resource_permissions(**kwargs)#

Describes the permissions of a specified resource.

See also: AWS API Documentation

Request Syntax

response = client.describe_resource_permissions(
    AuthenticationToken='string',
    ResourceId='string',
    PrincipalId='string',
    Limit=123,
    Marker='string'
)
Parameters:

  • AuthenticationToken (string) – Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.

  • ResourceId (string) –

    [REQUIRED]

    The ID of the resource.

  • PrincipalId (string) – The ID of the principal to filter permissions by.

  • Limit (integer) – The maximum number of items to return with this call.

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

Return type:

dict

Returns:

Response Syntax

{
    'Principals': [
        {
            'Id': 'string',
            'Type': 'USER'|'GROUP'|'INVITE'|'ANONYMOUS'|'ORGANIZATION',
            'Roles': [
                {
                    'Role': 'VIEWER'|'CONTRIBUTOR'|'OWNER'|'COOWNER',
                    'Type': 'DIRECT'|'INHERITED'
                },
            ]
        },
    ],
    'Marker': 'string'
}

Response Structure

  • (dict) –

    • Principals (list) –

      The principals.

      • (dict) –

        Describes a resource.

        • Id (string) –

          The ID of the resource.

        • Type (string) –

          The type of resource.

        • Roles (list) –

          The permission information for the resource.

          • (dict) –

            Describes the permissions.

            • Role (string) –

              The role of the user.

            • Type (string) –

              The type of permissions.

    • Marker (string) –

      The marker to use when requesting the next set of results. If there are no additional results, the string is empty.

Exceptions

  • WorkDocs.Client.exceptions.InvalidArgumentException

  • WorkDocs.Client.exceptions.UnauthorizedOperationException

  • WorkDocs.Client.exceptions.UnauthorizedResourceAccessException

  • WorkDocs.Client.exceptions.FailedDependencyException

  • WorkDocs.Client.exceptions.ServiceUnavailableException