Skip to content

DescribeUsersRequest

Source code in docs_src/capo_memorydb/types/describe_users_request.py
class DescribeUsersRequest(TypedDict, closed=True):
    user_name: NotRequired["capo_memorydb.types.user_name.UserName"]
    """<p>The name of the user.</p>"""
    filters: NotRequired["capo_memorydb.types.filter_list.FilterList"]
    """<p>Filter to determine the list of users to return.</p>"""
    max_results: NotRequired["capo_memorydb.types.integer_optional.IntegerOptional"]
    """<p>The maximum number of records to include in the response. If more records exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.</p>"""
    next_token: NotRequired["capo_memorydb.types.string.String"]
    """<p>An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. </p>"""

filters instance-attribute

filters: NotRequired[FilterList]

Filter to determine the list of users to return.

max_results instance-attribute

max_results: NotRequired[IntegerOptional]

The maximum number of records to include in the response. If more records exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

next_token instance-attribute

next_token: NotRequired[String]

An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

user_name instance-attribute

user_name: NotRequired[UserName]

The name of the user.