Skip to content

ListUsersRequest

Source code in docs_src/capo_transfer/types/list_users_request.py
class ListUsersRequest(TypedDict, closed=True):
    max_results: NotRequired["capo_transfer.types.max_results.MaxResults"]
    """<p>Specifies the number of users to return as a response to the <code>ListUsers</code> request.</p>"""
    next_token: NotRequired["capo_transfer.types.next_token.NextToken"]
    """<p>If there are additional results from the <code>ListUsers</code> call, a <code>NextToken</code> parameter is returned in the output. You can then pass the <code>NextToken</code> to a subsequent <code>ListUsers</code> command, to continue listing additional users.</p>"""
    server_id: "capo_transfer.types.server_id.ServerId"
    """<p>A system-assigned unique identifier for a server that has users assigned to it.</p>"""

max_results instance-attribute

max_results: NotRequired[MaxResults]

Specifies the number of users to return as a response to the ListUsers request.

next_token instance-attribute

next_token: NotRequired[NextToken]

If there are additional results from the ListUsers call, a NextToken parameter is returned in the output. You can then pass the NextToken to a subsequent ListUsers command, to continue listing additional users.

server_id instance-attribute

server_id: ServerId

A system-assigned unique identifier for a server that has users assigned to it.