WorkMail / Paginator / ListResources


class WorkMail.Paginator.ListResources#
paginator = client.get_paginator('list_resources')

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
        'NamePrefix': 'string',
        'PrimaryEmailPrefix': 'string',
        'State': 'ENABLED'|'DISABLED'|'DELETED'
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
  • OrganizationId (string) –


    The identifier for the organization under which the resources exist.

  • Filters (dict) –

    Limit the resource search results based on the filter criteria. You can only use one filter per request.

    • NamePrefix (string) –

      Filters only resource that start with the entered name prefix .

    • PrimaryEmailPrefix (string) –

      Filters only resource with the provided primary email prefix.

    • State (string) –

      Filters only resource with the provided state.

  • 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:



Response Syntax

    'Resources': [
            'Id': 'string',
            'Email': 'string',
            'Name': 'string',
            'Type': 'ROOM'|'EQUIPMENT',
            'State': 'ENABLED'|'DISABLED'|'DELETED',
            'EnabledDate': datetime(2015, 1, 1),
            'DisabledDate': datetime(2015, 1, 1),
            'Description': 'string'


Response Structure

  • (dict) –

    • Resources (list) –

      One page of the organization’s resource representation.

      • (dict) –

        The representation of a resource.

        • Id (string) –

          The identifier of the resource.

        • Email (string) –

          The email of the resource.

        • Name (string) –

          The name of the resource.

        • Type (string) –

          The type of the resource: equipment or room.

        • State (string) –

          The state of the resource, which can be ENABLED, DISABLED, or DELETED.

        • EnabledDate (datetime) –

          The date indicating when the resource was enabled for WorkMail use.

        • DisabledDate (datetime) –

          The date indicating when the resource was disabled from WorkMail use.

        • Description (string) –

          Resource description.