WorkMail / Paginator / ListResourceDelegates

ListResourceDelegates

class WorkMail.Paginator.ListResourceDelegates

paginator = client.get_paginator('list_resource_delegates')

paginate(**kwargs)

Creates an iterator that will paginate through responses from WorkMail.Client.list_resource_delegates().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    OrganizationId='string',
    ResourceId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• OrganizationId (string) –

  [REQUIRED]

  The identifier for the organization that contains the resource for which delegates are listed.

• ResourceId (string) –

  [REQUIRED]

  The identifier for the resource whose delegates are listed.

  The identifier can accept ResourceId, Resourcename, or email. The following identity formats are available:

  • Resource ID: r-0123456789a0123456789b0123456789

  • Email address: resource@domain.tld

  • Resource name: resource

• 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

{
    'Delegates': [
        {
            'Id': 'string',
            'Type': 'GROUP'|'USER'
        },
    ],

}

Response Structure

• (dict) –

  • Delegates (list) –

    One page of the resource’s delegates.

    • (dict) –

      The name of the attribute, which is one of the values defined in the UserAttribute enumeration.

      • Id (string) –

        The identifier for the user or group associated as the resource’s delegate.

      • Type (string) –

        The type of the delegate: user or group.