CloudDirectory / Paginator / ListDirectories


class CloudDirectory.Paginator.ListDirectories#
paginator = client.get_paginator('list_directories')

Creates an iterator that will paginate through responses from CloudDirectory.Client.list_directories().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
  • state (string) – The state of the directories in the list. Can be either Enabled, Disabled, or Deleted.

  • 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

    'Directories': [
            'Name': 'string',
            'DirectoryArn': 'string',
            'State': 'ENABLED'|'DISABLED'|'DELETED',
            'CreationDateTime': datetime(2015, 1, 1)


Response Structure

  • (dict) –

    • Directories (list) –

      Lists all directories that are associated with your account in pagination fashion.

      • (dict) –

        Directory structure that includes the directory name and directory ARN.

        • Name (string) –

          The name of the directory.

        • DirectoryArn (string) –

          The Amazon Resource Name (ARN) that is associated with the directory. For more information, see arns.

        • State (string) –

          The state of the directory. Can be either Enabled, Disabled, or Deleted.

        • CreationDateTime (datetime) –

          The date and time when the directory was created.