WorkDocs / Paginator / DescribeResourcePermissions

DescribeResourcePermissions

class WorkDocs.Paginator.DescribeResourcePermissions

paginator = client.get_paginator('describe_resource_permissions')

paginate(**kwargs)

Creates an iterator that will paginate through responses from WorkDocs.Client.describe_resource_permissions().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    AuthenticationToken='string',
    ResourceId='string',
    PrincipalId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': '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.

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'Principals': [
        {
            'Id': 'string',
            'Type': 'USER'|'GROUP'|'INVITE'|'ANONYMOUS'|'ORGANIZATION',
            'Roles': [
                {
                    'Role': 'VIEWER'|'CONTRIBUTOR'|'OWNER'|'COOWNER',
                    'Type': 'DIRECT'|'INHERITED'
                },
            ]
        },
    ],
    'NextToken': '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.

  • NextToken (string) –

    A token to resume pagination.