Skip to content

ListMembersInput

Source code in docs_src/capo_managedblockchain/types/list_members_input.py
class ListMembersInput(TypedDict, closed=True):
    network_id: "capo_managedblockchain.types.resource_id_string.ResourceIdString"
    """<p>The unique identifier of the network for which to list members.</p>"""
    name: NotRequired["capo_managedblockchain.types.string.String"]
    """<p>The optional name of the member to list.</p>"""
    status: NotRequired["capo_managedblockchain.types.member_status.MemberStatus"]
    """<p>An optional status specifier. If provided, only members currently in this status are listed.</p>"""
    is_owned: NotRequired["capo_managedblockchain.types.is_owned.IsOwned"]
    """<p>An optional Boolean value. If provided, the request is limited either to members that the current Amazon Web Services account owns (<code>true</code>) or that other Amazon Web Services accountsn own (<code>false</code>). If omitted, all members are listed.</p>"""
    max_results: NotRequired[
        "capo_managedblockchain.types.member_list_max_results.MemberListMaxResults"
    ]
    """<p>The maximum number of members to return in the request.</p>"""
    next_token: NotRequired[
        "capo_managedblockchain.types.pagination_token.PaginationToken"
    ]
    """<p>The pagination token that indicates the next set of results to retrieve.</p>"""

is_owned instance-attribute

is_owned: NotRequired[IsOwned]

An optional Boolean value. If provided, the request is limited either to members that the current Amazon Web Services account owns (true) or that other Amazon Web Services accountsn own (false). If omitted, all members are listed.

max_results instance-attribute

max_results: NotRequired[MemberListMaxResults]

The maximum number of members to return in the request.

name instance-attribute

name: NotRequired[String]

The optional name of the member to list.

network_id instance-attribute

network_id: ResourceIdString

The unique identifier of the network for which to list members.

next_token instance-attribute

next_token: NotRequired[PaginationToken]

The pagination token that indicates the next set of results to retrieve.

status instance-attribute

status: NotRequired[MemberStatus]

An optional status specifier. If provided, only members currently in this status are listed.