Skip to content

DescribeDirectoriesRequest

Source code in docs_src/capo_directory_service/types/describe_directories_request.py 
13
14
15
16
17
18
19
20
21
class DescribeDirectoriesRequest(TypedDict, closed=True):
    directory_ids: NotRequired[
        "capo_directory_service.types.directory_ids.DirectoryIds"
    ]
    """<p>A list of identifiers of the directories for which to obtain the information. If this member is null, all directories that belong to the current account are returned.</p> <p>An empty list results in an <code>InvalidParameterException</code> being thrown.</p>"""
    next_token: NotRequired["capo_directory_service.types.next_token.NextToken"]
    """<p>The <code>DescribeDirectoriesResult.NextToken</code> value from a previous call to <a>DescribeDirectories</a>. Pass null if this is the first call.</p>"""
    limit: NotRequired["capo_directory_service.types.limit.Limit"]
    """<p>The maximum number of items to return. If this value is zero, the maximum number of items is specified by the limitations of the operation.</p>"""

directory_ids instance-attribute 

directory_ids: NotRequired[DirectoryIds]

A list of identifiers of the directories for which to obtain the information. If this member is null, all directories that belong to the current account are returned.

An empty list results in an InvalidParameterException being thrown.

limit instance-attribute 

limit: NotRequired[Limit]

The maximum number of items to return. If this value is zero, the maximum number of items is specified by the limitations of the operation.

next_token instance-attribute 

next_token: NotRequired[NextToken]

The DescribeDirectoriesResult.NextToken value from a previous call to DescribeDirectories. Pass null if this is the first call.